TB Wiki - User contributions [en]

TB Wiki:General disclaimer

2026-03-31T18:55:39Z

Serdar Civici: Created page with "This page has no content."

This page has no content.

TB Wiki:About

2026-03-31T18:55:32Z

Serdar Civici: Created page with "This page has no content."

This page has no content.

TB Wiki:Privacy policy

2026-03-31T18:55:20Z

Serdar Civici: Created page with "This page has no content."

This page has no content.

ProSBC:Restful API SIP Domain

2024-08-15T20:02:56Z

Serdar Civici:

You can create and modify a SIP Domain in your system with RestFul API using JSON in the following format:

<pre>

{
"min_contact_expire": "30 seconds",
"max_contact_expire": "1 hour",
"enabled": true,
"routing_method": "Register Source",
"domain_name": "sip.telcobridges.com",
"advanced_parameters": {
"poll_registered_users_parameters": {
"***meta***": {
"valid_url": false
},
"poll_registered_users_interval": "20 seconds",
"poll_registered_users_user_agent": "",
"poll_registered_users": false
},
"unsubscribe_on_unregister": true,
"***meta***": {
"valid_url": false
},
"contact_expire_grace_time": "1 minute",
"strict_user_matching": false
},
"sip_registration_registrars": {},
"***meta***": {
"version": "3.1.137",
"src_path": ""
},
"naps": [
"3CX",
"OPEN_NAP"
],
"default_contact_expire": "1 hour",
"forwarding_parameters": {
"forwarding_mode": "Contact Remapping",
"***meta***": {
"valid_url": false
},
"forward_after_switchover": true,
"override_received_user_agent": false,
"max_simultaneous_register_forward": 10000,
"max_pending_register_forward": 10000,
"min_registrar_expire": "1 hour"
},
"name": "TEST_DOMAIN",
"unique_name": "sip.telcobridges.com",
"registration_method": "Forwarding",
"max_registered_users": 100000
}

</pre>

Important parameters in the JSON file

* [[Parameter: Name|name]]
* [[Parameter: Domain name|domain_name]]
* [[Parameter: Routing Method|routing_method]]
* [[Parameter: Forwarding Mode|forwarding_mode]]

==Adding a new SIP Domain==

You can add a new SIP Domain with the POST command:

POST http://ProSBCIP:12358/configurations/configuration_name/sip_registration_domains/

ProSBC will create a new SIP Domain from the name in the JSON file.

Example: Using the Postman tool, the URL is:

http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/

[[Image:RestFul_sip_domain_Post_Send.png|800px| ]]

If the new SIP Domain is created successfully, the following message is returned:

[[Image:RestFul_sip_domain_Post_Response.png|800px| ]]

==Modifiying a SIP Domain==

You can modify the existing SIP Domain with the PUT command:

PUT http://ProSBCIP:12358/configurations/configurationname/sip_registration_domains/sip_domain_name

Example: Using the Postman tool, the URL is

http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/TEST_DOMAIN and changed routing_method to Contact

[[Image:SIP_Domain_Put_Send.png|800px| ]]

If the update is successful, the following message is returned:

[[Image:SIP_Domain_Put_Response.png|800px| ]]

Learn more about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]].

ProSBC:Cloud:AWS Installation-B

2024-07-11T17:04:04Z

Serdar Civici:

{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}
<a href="#" id="hideToc">Hide TOC</a>
==Introduction==
This article provides guidance for people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
 
'''NOTE''' The old installation guide is located here: [[FreeSBC:Cloud:AWS_Installation_A|AWS installation]]

==Instantiate a ProSBC==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]

* Be sure that you are in the correct region. On the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:
[[File:AWS EC2 AMIs.png|900px|thumb|center]]

* Launch the FreeSBC/ProSBC image.
[[File:EC2 launch AMI.png|900px|thumb|center]]

* Name the instance and add any necessary tag
[[File:EC2-AMI Launch.png|900px|thumb|center]]

* Select the instance type and its resources. The recommended instance type is:
** m5.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), M5 and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Calls per second (cps)
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass
|-
| valign="top" |
m5.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m5.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.2xlarge
| valign="top" |
8
| valign="top" |
575
| valign="top" |
2,000
| valign="top" |
60,000
|-
| valign="top" |
m5.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m5.12xlarge
| valign="top" |
48
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:EC2 AMI CPU.png|900px|thumb|center]]

* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.

[[File:EC2 AWS Key pair.png|900px|thumb|center]]

* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)

[[File:EC2 AMI Network.png|900px|thumb|center]]

* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2.

[[File:EC2 AMI Storage.png|900px|thumb|center]]

* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:

[[File:EC2 AMI Launch.png|900px|thumb|center]]

* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:

[[File:EC2 AMI Confirmation.png|900px|thumb|center]]

* After a few minutes your instance should be running and available to be configured:

[[File:EC2 AMI Instances.png|900px|thumb|center]]

=== Optional: Elastic IP Creation section ===
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommends associating an Elastic IP to your instance, which is, in short, to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].

== Enable SR-IOV enhanced networking ==
By default M5 instances have enhanced networking enabled. If you want to use any other instance, like m4 type instance, you need to check if enahnced networking is enabled or not.

It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.

This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''

There are two types of enhanced networking, we need the second one.

1) Elastic Network Adapter (ENA)

2) Intel 82599 Virtual Function (VF) interface

===Install the AWS CLI===
https://aws.amazon.com/cli/

===Get security credentials for the command line===
On the AWS web portal, click on your account name and choose "My Security Credentials"

Expand the "Access keys" section

Create a new key, you will need the AWSAccessKeyId and AWSSecretKey

===Open a CLI and execute the aws cli commands===
aws configure

Paste the access key ID and key that you previously obtained along with your default region.

===Show if the enhanced networking is enabled===
Make sure to replace the example instance ID with your own AWS instance ID

aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport

Enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {
"Value": "simple"
}
}

Not enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {}
}

To enable the sriov enhanced networking, first turn off the instance then do:

aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple

== Accessing the ProSBC ==
=== Accessing the ProSBC web portal ===
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the ProSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

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

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Installing AWS Instance with CloudFormation Template ==
AWS CloudFormation is a service that helps you model and set up your AWS resources so that you can spend less time managing those resources and more time focusing on your applications that run in AWS. Telcobridge created a CloudFormation template to reduce the time spent on ProSBC AWS installation. Click on the following link to the ProSBC CloudFormation installation:
[[TSBC-SW:WebPortal:ProSBC CloudFormation Installation|ProSBCAWS CloudFormation Installation]]

== Upgrading the instance type ==
You can upgrade the instance type in AWS based on your requirements. Click on the following link for instance type upgrade
[[TSBC-SW:WebPortal:ProSBC Instance Upgrade|ProSBC AWS Intance Upgrade]]

== Adding more interfaces to ProSBC in AWS ==
You can add more interfaces to ProSBC in AWS based on your requirements. Click on the following link for how to add an interface
[[TSBC-SW:WebPortal:ProSBC AWS Additional Interface|ProSBC AWS Additional Interface]]

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]

== AWS using NAT ==
Since the AWS instance is behind NAT, you must adjust the NAT settings for the SBC:
[[Toolpack:Tsbc IP Network Settings 3.1 #tab=NAT|IP Network Settings]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]
[[Category:Revise on Major]]

== External References ==
* [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connect-to-linux-instance.html Accessing device with SSH and private key using putty]

ProSBC:Cloud:AWS Installation-B

2024-04-03T14:38:42Z

Serdar Civici: /* External References */

{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
 
'''NOTE''' The old installation guide is here: [[FreeSBC:Cloud:AWS_Installation_A|AWS installation]]

== '''Instantiate a ProSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]

* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:
[[File:AWS EC2 AMIs.png|900px|thumb|center]]

* Launch the FreeSBC/ProSBC image.
[[File:EC2 launch AMI.png|900px|thumb|center]]

* Name the instance and add any necessary tag
[[File:EC2-AMI Launch.png|900px|thumb|center]]

* Select the instance type and its resources. The recommended instance type is:
** m5.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), M5 and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Calls per second (cps)
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass
|-
| valign="top" |
m5.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m5.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.2xlarge
| valign="top" |
8
| valign="top" |
575
| valign="top" |
2,000
| valign="top" |
60,000
|-
| valign="top" |
m5.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m5.12xlarge
| valign="top" |
48
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:EC2 AMI CPU.png|900px|thumb|center]]

* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.

[[File:EC2 AWS Key pair.png|900px|thumb|center]]

* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)

[[File:EC2 AMI Network.png|900px|thumb|center]]

* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2.

[[File:EC2 AMI Storage.png|900px|thumb|center]]

* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:

[[File:EC2 AMI Launch.png|900px|thumb|center]]

* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:

[[File:EC2 AMI Confirmation.png|900px|thumb|center]]

* After a few minutes your instance should be running and available to be configured:

[[File:EC2 AMI Instances.png|900px|thumb|center]]

=== Optional: Elastic IP Creation section ===
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommends associating an Elastic IP to your instance, which is, in short, to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].

== Enable SR-IOV enhanced networking ==
By default M5 instances have enhanced networking enabled. If you want to use any other instance, like m4 type instance, you need to check if enahnced networking is enabled or not.

It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.

This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''

There are two types of enhanced networking, we need the second one.

1) Elastic Network Adapter (ENA)

2) Intel 82599 Virtual Function (VF) interface

===Install the AWS CLI===
https://aws.amazon.com/cli/

===Get security credentials for the command line===
On the AWS web portal, click on your account name and choose "My Security Credentials"

Expand the "Access keys" section

Create a new key, you will need the AWSAccessKeyId and AWSSecretKey

===Open a CLI and execute the aws cli commands===
aws configure

Paste the access key ID and key that you previously obtained along with your default region.

===Show if the enhanced networking is enabled===
Make sure to replace the example instance ID with your own AWS instance ID

aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport

Enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {
"Value": "simple"
}
}

Not enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {}
}

To enable the sriov enhanced networking, first turn off the instance then do:

aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple

== Accessing the ProSBC ==
=== Accessing the ProSBC web portal ===
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the ProSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

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

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Installing AWS Instance with CloudFormation Template ==
AWS CloudFormation is a service that helps you model and set up your AWS resources so that you can spend less time managing those resources and more time focusing on your applications that run in AWS. Telcobridge created a CloudFormation template to reduce the time spent on ProSBC AWS installation. Click on the following link to the ProSBC CloudFormation installation:
[[TSBC-SW:WebPortal:ProSBC CloudFormation Installation|ProSBCAWS CloudFormation Installation]]

== Upgrading the instance type ==
You can upgrade the instance type in AWS based on your requirements. Click on the following link for instance type upgrade
[[TSBC-SW:WebPortal:ProSBC Instance Upgrade|ProSBC AWS Intance Upgrade]]

== Adding more interfaces to ProSBC in AWS ==
You can add more interfaces to ProSBC in AWS based on your requirements. Click on the following link for how to add an interface
[[TSBC-SW:WebPortal:ProSBC AWS Additional Interface|ProSBC AWS Additional Interface]]

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]
[[Category:Revise on Major]]

== External References ==
* [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/putty.html Accessing device with SSH and private key using putty]

Configuring letsencrypt certificate

2024-03-26T13:54:05Z

Serdar Civici:

=== '''''Applies to version: v3.1, v3.1''''' ===
{{DISPLAYTITLE:Configuring letsencrypt certificate}}
__NOTOC__
=Introduction=
Let’s Encrypt is a free, automated, and open certificate authority (CA), run for the public’s benefit. It is a service provided by the Internet Security Research Group (ISRG). This tutorial provides you how to configure letsencrypt certificate to use in Telcobridges equipment's.
==Prerequisites==
Make sure HTTPS is enabled for the HTTP default service at port 12358.

== Configuration Procedure ==

Note that the below procedure will survive a toolpack upgrade without breaking HTTPS.

'''1. Install certbot and python3'''

<pre> # Install python3 with virtual environment.
sudo yum -y install python3
sudo python3 -m venv /opt/pycertbot/
sudo /opt/pycertbot/bin/pip install --upgrade pip

# Install required dependency
sudo /opt/pycertbot/bin/pip install pyOpenSSL==23.1.1

# Install certbot from pip
sudo /opt/pycertbot/bin/pip install certbot certbot
sudo ln -s /opt/pycertbot/bin/certbot /usr/bin/certbot </pre>

'''2. Create certificate'''

If unsure, you can temporarily generate a test certificate with --test-cert.
Replace the two -d with proper FQDNs, then run:
<pre>sudo certbot certonly --standalone --agree-tos \
-d CUSTOMER1.saas.prosbc.com \
-d ec2-3-96-231-114.ca-central-1.prosbc.com \
--deploy-hook "cat \${RENEWED_LINEAGE}/privkey.pem \${RENEWED_LINEAGE}/fullchain.pem > \${RENEWED_LINEAGE}/fullchain_with_privkey.pem && ln --force -s \${RENEWED_LINEAGE}/fullchain_with_privkey.pem /lib/tb/toolpack/pkg/ssl_certificate/toolpack_cert.pem && killall -INT lighttpd" \
--email certificate_saas@telcobridges.com --no-eff-email</pre>

(the toolpack web server will automatically reload to use the new certificate, thanks to the --deploy-hook)

'''3. Validation'''

Validate that a symbolic link is present here:
<pre>ls -l /lib/tb/toolpack/pkg/ssl_certificate/toolpack_cert.pem</pre>
* It should point at /etc/letsencrypt/live/FQDN/fullchain_with_privkey.pem
If successful, you can access in HTTPS without any warning from the browser!

'''4. Setup automatic renewal'''
The certificate is valid for 90 days, so we have to enable automatic renewal.

Add the following lines in /etc/crontab:
<pre># Run daily at 1 AM
0 1 * * * certbot renew --quiet --agree-tos</pre>

After a few days, validate there are log files created at 1 AM every day:
* <pre>sudo ls -lrt /var/log/letsencrypt/</pre>

Configuring letsencrypt certificate

2024-03-26T13:46:04Z

Serdar Civici: /* Configuration Procedure */

Configuring letsencrypt certificate

2024-03-26T13:45:32Z

Serdar Civici:

=== '''''Applies to version: v3.1, v3.1''''' ===
{{DISPLAYTITLE:Configuring letsencrypt certificate}}
__NOTOC__
=Introduction=
Let’s Encrypt is a free, automated, and open certificate authority (CA), run for the public’s benefit. It is a service provided by the Internet Security Research Group (ISRG). This tutorial provides you how to configure letsencrypt certificate to use in Telcobridges equipment's.
==Prerequisites==
Make sure HTTPS is enabled for the HTTP default service at port 12358.

== Configuration Procedure ==

Note that the below procedure will survive a toolpack upgrade without breaking HTTPS.

'''1.''' Install certbot and python3

<pre> # Install python3 with virtual environment.
sudo yum -y install python3
sudo python3 -m venv /opt/pycertbot/
sudo /opt/pycertbot/bin/pip install --upgrade pip

# Install required dependency
sudo /opt/pycertbot/bin/pip install pyOpenSSL==23.1.1

# Install certbot from pip
sudo /opt/pycertbot/bin/pip install certbot certbot
sudo ln -s /opt/pycertbot/bin/certbot /usr/bin/certbot </pre>

'''2.''' Create certificate

If unsure, you can temporarily generate a test certificate with --test-cert.
Replace the two -d with proper FQDNs, then run:
<pre>sudo certbot certonly --standalone --agree-tos \
-d CUSTOMER1.saas.prosbc.com \
-d ec2-3-96-231-114.ca-central-1.prosbc.com \
--deploy-hook "cat \${RENEWED_LINEAGE}/privkey.pem \${RENEWED_LINEAGE}/fullchain.pem > \${RENEWED_LINEAGE}/fullchain_with_privkey.pem && ln --force -s \${RENEWED_LINEAGE}/fullchain_with_privkey.pem /lib/tb/toolpack/pkg/ssl_certificate/toolpack_cert.pem && killall -INT lighttpd" \
--email certificate_saas@telcobridges.com --no-eff-email</pre>

(the toolpack web server will automatically reload to use the new certificate, thanks to the --deploy-hook)

'''3.''' Validation

Validate that a symbolic link is present here:
<pre>ls -l /lib/tb/toolpack/pkg/ssl_certificate/toolpack_cert.pem</pre>
* It should point at /etc/letsencrypt/live/FQDN/fullchain_with_privkey.pem
If successful, you can access in HTTPS without any warning from the browser!

'''4.''' Setup automatic renewal
The certificate is valid for 90 days, so we have to enable automatic renewal.

Add the following lines in /etc/crontab:
<pre># Run daily at 1 AM
0 1 * * * certbot renew --quiet --agree-tos</pre>

After a few days, validate there are log files created at 1 AM every day:
* <pre>sudo ls -lrt /var/log/letsencrypt/</pre>

Configuring letsencrypt certificate

2024-03-26T13:42:40Z

Serdar Civici:

=== '''''Applies to version: v3.1, v3.1''''' ===
{{DISPLAYTITLE:Configuring letsencrypt certificate}}
__NOTOC__
=Introduction=
Let’s Encrypt is a free, automated, and open certificate authority (CA), run for the public’s benefit. It is a service provided by the Internet Security Research Group (ISRG). This tutorial provides you how to configure letsencrypt certificate to use in Telcobridges equipment's.
==Prerequisites==
Make sure HTTPS is enabled for the HTTP default service at port 12358.

== Configuration Procedure ==

Note that the below procedure will survive a toolpack upgrade without breaking HTTPS.

'''1.''' Install certbot and python3

<code> # Install python3 with virtual environment.
sudo yum -y install python3
sudo python3 -m venv /opt/pycertbot/
sudo /opt/pycertbot/bin/pip install --upgrade pip

# Install required dependency
sudo /opt/pycertbot/bin/pip install pyOpenSSL==23.1.1

# Install certbot from pip
sudo /opt/pycertbot/bin/pip install certbot certbot
sudo ln -s /opt/pycertbot/bin/certbot /usr/bin/certbot </code>

'''2.''' Create certificate

If unsure, you can temporarily generate a test certificate with --test-cert.
Replace the two -d with proper FQDNs, then run:
<pre>sudo certbot certonly --standalone --agree-tos \
-d CUSTOMER1.saas.prosbc.com \
-d ec2-3-96-231-114.ca-central-1.prosbc.com \
--deploy-hook "cat \${RENEWED_LINEAGE}/privkey.pem \${RENEWED_LINEAGE}/fullchain.pem > \${RENEWED_LINEAGE}/fullchain_with_privkey.pem && ln --force -s \${RENEWED_LINEAGE}/fullchain_with_privkey.pem /lib/tb/toolpack/pkg/ssl_certificate/toolpack_cert.pem && killall -INT lighttpd" \
--email certificate_saas@telcobridges.com --no-eff-email</pre>

(the toolpack web server will automatically reload to use the new certificate, thanks to the --deploy-hook)

'''3.''' Validation

Validate that a symbolic link is present here:
<pre>ls -l /lib/tb/toolpack/pkg/ssl_certificate/toolpack_cert.pem</pre>

Configuring letsencrypt certificate

2024-03-26T13:36:12Z

Serdar Civici:

Configuring letsencrypt certificate

2024-03-26T13:29:34Z

Serdar Civici: Created page with "=== '''''Applies to version: v3.1, v3.1''''' === {{DISPLAYTITLE:Configuring letsencrypt certificate}} __NOTOC__ =Introduction= Let’s Encrypt is a free, automated, and open certificate authority (CA), run for the public’s benefit. It is a service provided by the Internet Security Research Group (ISRG). This tutorial provides you how to configure letsencrypt certificate to use in Telcobridges equipment's. ==Prerequisites== Make sure HTTPS is enabled for the HTTP defaul..."

Toolpack:Configure HTTPS certificates A

2024-03-26T13:21:30Z

Serdar Civici:

{{DISPLAYTITLE:Configure HTTPS certificates}}
{| class="wikitable"
|-
|rowspan="3"|This article applies to:
|'''Product'''
|'''Version'''
|-
|Tmedia
|2.9, 2.10, 3.0, 3.2
|-
|ProSBC
|3.1, 3.1.117 or later
|}
If you created a HTTP service using HTTPS and want to have an officially signed certificate, follow these steps

1. Activate the HTTPS on the unit to have the system generate a self-signed certificate.

2. Log in as root using SSH to your unit and go to /lib/tb/toolpack/pkg/ssl_certificate.
cd /lib/tb/toolpack/pkg/ssl_certificate

3. Create a 'certificate signing request' form and private key using the following command:
openssl req -out CSR.csr -new -newkey rsa:2048 -nodes -keyout privateKey.key
You will be prompted for information. One of the prompts is for the 'common name'. Set it to the URL that you will use to access the unit. If an IP address is used, we strongly recommend it to either be static or 'reserved' in the DHCP.

For example:
https://192.168.130.3:12358 -> common name = 192.168.130.3
https://myunit.lan:12358 -> common name = myunit.lan
4. The previous step should have created two files:
CSR.csr
privateKey.key
5. Download the generated CSR.csr from your unit (using SCP) and sent it to your signing authority to get a signed certificate.

6. Once you have the signed certificate, upload it to your unit (using SCP) in the same directory as before.

7. Concatenate the private key and signed certificate and replace the contents of the file toolpack_cert.pem
rm -f toolpack_cert.*
cat privateKey.key <yoursignedcertificatefile> > toolpack_cert.pem

8. Restart the Webportal process to load the new certificate.
killall lighttpd

==Using letsencrypt certificate for HTTPS ==

The following link describe how to configure letsencrypt certificate to use in Telcobridges products.

*[[Configuring letsencrypt certificate|Configuring letsencrypt certificate for HTTPS]]

TBReport

2024-03-06T15:44:53Z

Serdar Civici:

{{DISPLAYTITLE:TBReport}}
{| class="wikitable"
|-
|rowspan="3"|This article applies to:
|'''Product'''
|'''Version'''
|-
|Tmedia
|2.9, 2.10, 3.0, 3.1, 3.2
|}

You can create a report (Called TBreport or TB report) directly from the web portal. This report captures the following logs from the system:
*Backup of the configuration (mysql DB backup)
*Application logs including:
**gateway (routing and other high-level functions)
**logtrace (low-level hardware traces)
**Stream_server
**tboam_app (Application and HA manager)
**tbsnmpagent
**tbuctwriter
**toolpack_engine (Signaling processing)
**toolpack_sys_manager (Hardware configuration)
*tb640debug (low level configuration of the hardware units)
*tbtelnetdump (low level commands on hardware units)

To activate the report:
*Select '''Report''' from the navigation menu.

[[Image:Maintenance_Report.png]]
 
 
Select the time range and click '''Create'''. 
[[Image:Maintenance_Report_Archive.png]] 
[[Image:Maintenance_Report_Archive_list.png]] 
This will create a single file that can be downloaded for analysis, or sent to the TelcoBridges support team (support@telcobridges.com) 

[[category:FAQ]]

TSBC-SW:WebPortal:ProSBC AWS Additional Interface

2024-02-01T16:56:37Z

Serdar Civici:

This page guides people to add additional network interfaces to the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console.

1. Login to your AWS account.

2. Go to EC2 - > Network & Security -> Network Interfaces -> Create Network Interface

[[Image:aws_interface_1.png|600px]]

3. Follow the procedure below to Create a network interface page

[[Image:aws_interface_2.png|400px]]

'''Description:''' Description of the new interface.

'''Subnet:''' In this section select the subnet that is already assigned to ProSBC Interface. You can find that information under the Instance Details.

In the Security groups, assign the correct security group to new interface:

[[Image:aws_interface_3.png|400px]]

Click on to '''Create network interface''' button.

4. You can assign an Elastic IP address to new created Network Interface.
Go to '''EC2 - > Network & Security -> Network Interfaces -> Elastic IPs'''. If you already allocate elastic IPs that are not used assign one of them the to newly created interface. If you don’t have any elastic IP click on '''Allocate Elastic IP address''' button to get a new Elastic IP address.

5. In the EC2 Instances, choose the one you want to add to the new network interface.
Go to '''Actions -> Networking -> Attach Network Interface'''

[[Image:aws_interface_4.png|400px]]

Select the new interface you created from the Network Interface drop-down menuı and click to Attach button.

[[Image:aws_interface_5.png|400px]]

6. To assign the interface in the ProSBC, you need to reboot the instance. You can reboot from CLI or use AWS to reboot it.

[[Image:aws_interface_6.png|400px]]

7. Access the Web Portal to add the new interface in the SBC configuration

[[Image:aws_interface_7.png|400px]]

[[Image:aws_interface_8.png|400px]]

[[Image:aws_interface_9.png|400px]]

8. Follow the procedure below to configure new IP Interface

*[[Toolpack:Configuring_IP_Interface_SBC_A|Configuring IP Interfaces]]

TSBC-SW:WebPortal:ProSBC AWS Additional Interface

2024-02-01T16:56:13Z

Serdar Civici:

This page guides people to add additional network interfaces to the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console.

1. Login to your AWS account.

2. Go to EC2 - > Network & Security -> Network Interfaces -> Create Network Interface

[[Image:aws_interface_1.png|400px]]

3. Follow the procedure below to Create a network interface page

[[Image:aws_interface_2.png|400px]]

'''Description:''' Description of the new interface.

'''Subnet:''' In this section select the subnet that is already assigned to ProSBC Interface. You can find that information under the Instance Details.

In the Security groups, assign the correct security group to new interface:

[[Image:aws_interface_3.png|400px]]

Click on to '''Create network interface''' button.

4. You can assign an Elastic IP address to new created Network Interface.
Go to '''EC2 - > Network & Security -> Network Interfaces -> Elastic IPs'''. If you already allocate elastic IPs that are not used assign one of them the to newly created interface. If you don’t have any elastic IP click on '''Allocate Elastic IP address''' button to get a new Elastic IP address.

5. In the EC2 Instances, choose the one you want to add to the new network interface.
Go to '''Actions -> Networking -> Attach Network Interface'''

[[Image:aws_interface_4.png|400px]]

Select the new interface you created from the Network Interface drop-down menuı and click to Attach button.

[[Image:aws_interface_5.png|400px]]

6. To assign the interface in the ProSBC, you need to reboot the instance. You can reboot from CLI or use AWS to reboot it.

[[Image:aws_interface_6.png|400px]]

7. Access the Web Portal to add the new interface in the SBC configuration

[[Image:aws_interface_7.png|400px]]

[[Image:aws_interface_8.png|400px]]

[[Image:aws_interface_9.png|400px]]

8. Follow the procedure below to configure new IP Interface

*[[Toolpack:Configuring_IP_Interface_SBC_A|Configuring IP Interfaces]]

TSBC-SW:WebPortal:ProSBC AWS Additional Interface

2024-02-01T16:55:45Z

Serdar Civici:

This page guides people to add additional network interfaces to the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console.

1. Login to your AWS account.

2. Go to EC2 - > Network & Security -> Network Interfaces -> Create Network Interface

[[Image:aws_interface_1.png|400px]]

3. Follow the procedure below to Create a network interface page

[[Image:aws_interface_2.png|400px]]

'''Description:''' Description of the new interface.

'''Subnet:''' In this section select the subnet that is already assigned to ProSBC Interface. You can find that information under the Instance Details.

In the Security groups, assign the correct security group to new interface:

[[Image:aws_interface_3.png|400px]]

Click on to '''Create network interface''' button.

4. You can assign an Elastic IP address to new created Network Interface.
Go to '''EC2 - > Network & Security -> Network Interfaces -> Elastic IPs'''. If you already allocate elastic IPs that are not used assign one of them the to newly created interface. If you don’t have any elastic IP click on '''Allocate Elastic IP address''' button to get a new Elastic IP address.

5. In the EC2 Instances, choose the one you want to add to the new network interface.
Go to '''Actions -> Networking -> Attach Network Interface'''

[[Image:aws_interface_4.png|400px]]

Select the new interface you created from the Network Interface drop-down menuı and click to Attach button.

[[Image:aws_interface_5.png|400px]]

6. To assign the interface in the ProSBC, you need to reboot the instance. You can reboot from CLI or use AWS to reboot it.

[[Image:aws_interface_6.png|400px]]

7. Access the Web Portal to add the new interface in the SBC configuration

[[Image:aws_interface_7.png|400px]]

[[Image:aws_interface_8.png|400px]]

[[Image:aws_interface_9.png|400px]]

8. Follow the procedure below to configure new IP Interface

*[[Toolpack:Configuring_IP_Interface_SBC_A|Configuring IP Interfaces]]

TSBC-SW:WebPortal:ProSBC AWS Additional Interface

2024-02-01T16:55:24Z

Serdar Civici:

This page guides people to add additional network interfaces to the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console.

1. Login to your AWS account.

2. Go to EC2 - > Network & Security -> Network Interfaces -> Create Network Interface

[[Image:aws_interface_1.png|400px]]

3. Follow the procedure below to Create a network interface page

[[Image:aws_interface_2.png|400px]]

'''Description:''' Description of the new interface.
'''Subnet:''' In this section select the subnet that is already assigned to ProSBC Interface. You can find that information under the Instance Details.

In the Security groups, assign the correct security group to new interface:

[[Image:aws_interface_3.png|400px]]

Click on to '''Create network interface''' button.

4. You can assign an Elastic IP address to new created Network Interface.
Go to '''EC2 - > Network & Security -> Network Interfaces -> Elastic IPs'''. If you already allocate elastic IPs that are not used assign one of them the to newly created interface. If you don’t have any elastic IP click on '''Allocate Elastic IP address''' button to get a new Elastic IP address.

5. In the EC2 Instances, choose the one you want to add to the new network interface.
Go to '''Actions -> Networking -> Attach Network Interface'''

[[Image:aws_interface_4.png|400px]]

Select the new interface you created from the Network Interface drop-down menuı and click to Attach button.

[[Image:aws_interface_5.png|400px]]

6. To assign the interface in the ProSBC, you need to reboot the instance. You can reboot from CLI or use AWS to reboot it.

[[Image:aws_interface_6.png|400px]]

7. Access the Web Portal to add the new interface in the SBC configuration

[[Image:aws_interface_7.png|400px]]

[[Image:aws_interface_8.png|400px]]

[[Image:aws_interface_9.png|400px]]

8. Follow the procedure below to configure new IP Interface

*[[Toolpack:Configuring_IP_Interface_SBC_A|Configuring IP Interfaces]]

File:Aws interface 9.png

2024-02-01T16:54:04Z

Serdar Civici:

File:Aws interface 8.png

2024-02-01T16:53:48Z

Serdar Civici:

File:Aws interface 7.png

2024-02-01T16:52:55Z

Serdar Civici:

File:Aws interface 6.png

2024-02-01T16:52:14Z

Serdar Civici:

File:Aws interface 5.png

2024-02-01T16:51:50Z

Serdar Civici:

File:Aws interface 4.png

2024-02-01T16:51:24Z

Serdar Civici:

File:Aws interface 3.png

2024-02-01T16:50:57Z

Serdar Civici:

File:Aws interface 2.png

2024-02-01T16:50:32Z

Serdar Civici:

File:Aws interface 1.png

2024-02-01T16:50:02Z

Serdar Civici:

TSBC-SW:WebPortal:ProSBC AWS Additional Interface

2024-02-01T16:49:38Z

Serdar Civici: Created page with "This page guides people to add additional network interfaces to the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console. 1. Login to your AWS account. 2. Go to EC2 - > Network & Security -> Network Interfaces -> Create Network Interface 400px 3. Follow the procedure below to Create a network interface page 400px '''Description:''' Description of the new interface...."

This page guides people to add additional network interfaces to the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console.

1. Login to your AWS account.

2. Go to EC2 - > Network & Security -> Network Interfaces -> Create Network Interface

[[Image:aws_interface_1.png|400px]]

3. Follow the procedure below to Create a network interface page

[[Image:aws_interface_2.png|400px]]

'''Description:''' Description of the new interface.
'''Subnet:''' In this section select the subnet that is already assigned to ProSBC Interface. You can find that information under the Instance Details.

In the Security groups, assign the correct security group to new interface:

[[Image:aws_interface_3.png|400px]]

Click on to '''Create network interface''' button.

4. You can assign an Elastic IP address to new created Network Interface.
Go to '''EC2 - > Network & Security -> Network Interfaces -> Elastic IPs'''. If you already allocate elastic IPs that are not used assign one of them the to newly created interface. If you don’t have any elastic IP click on '''Allocate Elastic IP address''' button to get a new Elastic IP address.

5. In the EC2 Instances, choose the one you want to add to the new network interface.
Go to '''Actions -> Networking -> Attach Network Interface'''

[[Image:aws_interface_4.png|400px]]

Select the new interface you created from the Network Interface drop-down menuı and click to Attach button.

[[Image:aws_interface_5.png|400px]]

6. To assign the interface in the ProSBC, you need to reboot the instance. You can reboot from CLI or use AWS to reboot it.

[[Image:aws_interface_6.png|400px]]

7. Access the Web Portal to add the new interface in the SBC configuration

[[Image:aws_interface_7.png|400px]]

[[Image:aws_interface_8.png|400px]]

[[Image:aws_interface_9.png|400px]]

8. Follow the procedure below to configure new IP Interface

*[[Toolpack:Configuring_IP_Interface_SBC_A|Configuring IP Interfaces]]

ProSBC:Cloud:AWS Installation-B

2024-02-01T16:33:42Z

Serdar Civici:

{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
 
'''NOTE''' The old installation guide is here: [[FreeSBC:Cloud:AWS_Installation_A|AWS installation]]

== '''Instantiate a ProSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]

* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:
[[File:AWS EC2 AMIs.png|900px|thumb|center]]

* Launch the FreeSBC/ProSBC image.
[[File:EC2 launch AMI.png|900px|thumb|center]]

* Name the instance and add any necessary tag
[[File:EC2-AMI Launch.png|900px|thumb|center]]

* Select the instance type and its resources. The recommended instance type is:
** m5.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), M5 and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Calls per second (cps)
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass
|-
| valign="top" |
m5.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m5.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.2xlarge
| valign="top" |
8
| valign="top" |
575
| valign="top" |
2,000
| valign="top" |
60,000
|-
| valign="top" |
m5.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m5.12xlarge
| valign="top" |
48
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:EC2 AMI CPU.png|900px|thumb|center]]

* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.

[[File:EC2 AWS Key pair.png|900px|thumb|center]]

* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)

[[File:EC2 AMI Network.png|900px|thumb|center]]

* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2.

[[File:EC2 AMI Storage.png|900px|thumb|center]]

* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:

[[File:EC2 AMI Launch.png|900px|thumb|center]]

* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:

[[File:EC2 AMI Confirmation.png|900px|thumb|center]]

* After a few minutes your instance should be running and available to be configured:

[[File:EC2 AMI Instances.png|900px|thumb|center]]

=== Optional: Elastic IP Creation section ===
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommends associating an Elastic IP to your instance, which is, in short, to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].

== Enable SR-IOV enhanced networking ==
By default M5 instances have enhanced networking enabled. If you want to use any other instance, like m4 type instance, you need to check if enahnced networking is enabled or not.

It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.

This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''

There are two types of enhanced networking, we need the second one.

1) Elastic Network Adapter (ENA)

2) Intel 82599 Virtual Function (VF) interface

===Install the AWS CLI===
https://aws.amazon.com/cli/

===Get security credentials for the command line===
On the AWS web portal, click on your account name and choose "My Security Credentials"

Expand the "Access keys" section

Create a new key, you will need the AWSAccessKeyId and AWSSecretKey

===Open a CLI and execute the aws cli commands===
aws configure

Paste the access key ID and key that you previously obtained along with your default region.

===Show if the enhanced networking is enabled===
Make sure to replace the example instance ID with your own AWS instance ID

aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport

Enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {
"Value": "simple"
}
}

Not enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {}
}

To enable the sriov enhanced networking, first turn off the instance then do:

aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple

== Accessing the ProSBC ==
=== Accessing the ProSBC web portal ===
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the ProSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

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

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Installing AWS Instance with CloudFormation Template ==
AWS CloudFormation is a service that helps you model and set up your AWS resources so that you can spend less time managing those resources and more time focusing on your applications that run in AWS. Telcobridge created a CloudFormation template to reduce the time spent on ProSBC AWS installation. Click on the following link to the ProSBC CloudFormation installation:
[[TSBC-SW:WebPortal:ProSBC CloudFormation Installation|ProSBCAWS CloudFormation Installation]]

== Upgrading the instance type ==
You can upgrade the instance type in AWS based on your requirements. Click on the following link for instance type upgrade
[[TSBC-SW:WebPortal:ProSBC Instance Upgrade|ProSBC AWS Intance Upgrade]]

== Adding more interfaces to ProSBC in AWS ==
You can add more interfaces to ProSBC in AWS based on your requirements. Click on the following link for how to add an interface
[[TSBC-SW:WebPortal:ProSBC AWS Additional Interface|ProSBC AWS Additional Interfac]]

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]
[[Category:Revise on Major]]

== External References ==
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]

TSBC-SW:WebPortal:ProSBC Instance Upgrade

2024-01-17T15:05:59Z

Serdar Civici:

This page guides people to upgrade the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console. The instance change will affect the license. You need to contact with Telcobridges support team to get the new license.

Before starting to upgrade process, you need to be sure the existing M4 instance supports Enhanced Networking. Please check the following link:

[[ProSBC:Cloud:AWS_Installation-B|AWS installation instructions]] in section 2 Enable SR-IOV enhanced networking, you will find the documentation.

1. Login to your AWS account.

2. Go to EC2 and select the instance that you want to upgrade.

3. Click on '''Action''' and go to '''Instance Settings -> Change instance type'''

[[Image:Instance_Upgrade_1.png|400px]]

4. Select the new instance type to upgrade. Before selecting the new instance be sure the new instance is also in our supported instance list.

[[Image:Instance_Upgrade_2.png|400px]]

5. Click to '''Apply'''.

TSBC-SW:WebPortal:ProSBC Instance Upgrade

2024-01-17T15:05:47Z

Serdar Civici:

This page guides people to upgrade the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console. The instance change will affect the license. You need to contact with Telcobridges support team to get the new license.

Before starting to upgrade process, you need to be sure the existing M4 instance supports Enhanced Networking. Please check the following link:
[[ProSBC:Cloud:AWS_Installation-B|AWS installation instructions]] in section 2 Enable SR-IOV enhanced networking, you will find the documentation.

1. Login to your AWS account.

2. Go to EC2 and select the instance that you want to upgrade.

3. Click on '''Action''' and go to '''Instance Settings -> Change instance type'''

[[Image:Instance_Upgrade_1.png|400px]]

4. Select the new instance type to upgrade. Before selecting the new instance be sure the new instance is also in our supported instance list.

[[Image:Instance_Upgrade_2.png|400px]]

5. Click to '''Apply'''.

TSBC-SW:WebPortal:ProSBC Instance Upgrade

2024-01-08T18:59:12Z

Serdar Civici:

This page guides people to upgrade the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console. The instance change will affect the license. You need to contact with Telcobridges support team to get the new license.

1. Login to your AWS account.

2. Go to EC2 and select the instance that you want to upgrade.

3. Click on '''Action''' and go to '''Instance Settings -> Change instance type'''

[[Image:Instance_Upgrade_1.png|400px]]

4. Select the new instance type to upgrade. Before selecting the new instance be sure the new instance is also in our supported instance list.

[[Image:Instance_Upgrade_2.png|400px]]

5. Click to '''Apply'''.

TSBC-SW:WebPortal:ProSBC Instance Upgrade

2024-01-08T18:53:37Z

Serdar Civici:

File:Instance Upgrade 2.png

2024-01-08T18:53:18Z

Serdar Civici:

File:Instance Upgrade 1.png

2024-01-08T18:53:02Z

Serdar Civici:

TSBC-SW:WebPortal:ProSBC Instance Upgrade

2024-01-08T18:52:33Z

Serdar Civici:

TSBC-SW:WebPortal:ProSBC Instance Upgrade

2024-01-08T18:51:44Z

Serdar Civici: Created page with "This page guides people to upgrade the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console. The instance change will affect the license. You need contact with Telcobridges support team to get the new license. 1. Login to your AWS account. 2. Go to EC2 and select the instance that you want to upgrade. 3. Click on Action and go to Instance Settings -> Change instance type 800px 4. Select the new in..."

This page guides people to upgrade the ProSBC instance in AWS. Before starting this procedure you must have access to the AWS console. The instance change will affect the license. You need contact with Telcobridges support team to get the new license.

1. Login to your AWS account.
2. Go to EC2 and select the instance that you want to upgrade.
3. Click on Action and go to Instance Settings -> Change instance type
[[Image:Intance_Upgrade_1.png|800px]]
4. Select the new instance type to upgrade. Before selecting the new instance be sure the new instance is also in our supported instance list.
[[Image:Intance_Upgrade_2.png|800px]]
5. Click to Apply.

TSBC-SW:WebPortal:ProSBC CloudFormation Installation

2024-01-08T18:46:53Z

Serdar Civici:

{{DISPLAYTITLE: TSBC-SW:ProSBC CloudFormation Installation}}

This page guides people launching an instance of ProSBC using an AWS CloudFormation template.

*[[File:CloudFormation_Json.zip|Click here to download CloudFormation JSON template]]

To load the JSON file:

1. Log in to AWS with your account

2. Type '''CloudFormation''' in the search field and select it

[[Image:Cloud_Formation_1.png|800px]]

3. Click '''Create Stack'''

[[Image:Cloud_Formation_2.png|800px]]

4. Select '''Upload a template file''' and click '''Choose File''' to select the file. When the upload is finished, it will create an URL in the S3 Bucket for that file to store.
*Click '''Next'''

[[Image:Cloud_Formation_3.png|800px]]

5. The '''Stack Details''' window is displayed

[[Image:Cloud_Formation_4.png|800px]]
*'''Stack Name''': Enter a name for this newly created stack.
*'''Instance Name''': Enter a name for the instance that will created.
*'''Instance Type''': Select an instance type. By default it is '''m5.large'''.
*'''Key Name''': EC2 KeyPair to enable SSH access to the instance.

6. Click '''Next''' until the '''Submit''' button is shown.

ProSBC:Cloud:AWS Installation-B

2024-01-08T18:44:00Z

Serdar Civici:

{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
 
'''NOTE''' The old installation guide is here: [[FreeSBC:Cloud:AWS_Installation_A|AWS installation]]

== '''Instantiate a ProSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]

* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:
[[File:AWS EC2 AMIs.png|900px|thumb|center]]

* Launch the FreeSBC/ProSBC image.
[[File:EC2 launch AMI.png|900px|thumb|center]]

* Name the instance and add any necessary tag
[[File:EC2-AMI Launch.png|900px|thumb|center]]

* Select the instance type and its resources. The recommended instance type is:
** m5.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), M5 and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Calls per second (cps)
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass
|-
| valign="top" |
m5.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m5.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.2xlarge
| valign="top" |
8
| valign="top" |
575
| valign="top" |
2,000
| valign="top" |
60,000
|-
| valign="top" |
m5.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m5.12xlarge
| valign="top" |
48
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:EC2 AMI CPU.png|900px|thumb|center]]

* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.

[[File:EC2 AWS Key pair.png|900px|thumb|center]]

* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)

[[File:EC2 AMI Network.png|900px|thumb|center]]

* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2.

[[File:EC2 AMI Storage.png|900px|thumb|center]]

* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:

[[File:EC2 AMI Launch.png|900px|thumb|center]]

* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:

[[File:EC2 AMI Confirmation.png|900px|thumb|center]]

* After a few minutes your instance should be running and available to be configured:

[[File:EC2 AMI Instances.png|900px|thumb|center]]

=== Optional: Elastic IP Creation section ===
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommends associating an Elastic IP to your instance, which is, in short, to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].

== Enable SR-IOV enhanced networking ==
By default M5 instances have enhanced networking enabled. If you want to use any other instance, like m4 type instance, you need to check if enahnced networking is enabled or not.

It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.

This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''

There are two types of enhanced networking, we need the second one.

1) Elastic Network Adapter (ENA)

2) Intel 82599 Virtual Function (VF) interface

===Install the AWS CLI===
https://aws.amazon.com/cli/

===Get security credentials for the command line===
On the AWS web portal, click on your account name and choose "My Security Credentials"

Expand the "Access keys" section

Create a new key, you will need the AWSAccessKeyId and AWSSecretKey

===Open a CLI and execute the aws cli commands===
aws configure

Paste the access key ID and key that you previously obtained along with your default region.

===Show if the enhanced networking is enabled===
Make sure to replace the example instance ID with your own AWS instance ID

aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport

Enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {
"Value": "simple"
}
}

Not enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {}
}

To enable the sriov enhanced networking, first turn off the instance then do:

aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple

== Accessing the ProSBC ==
=== Accessing the ProSBC web portal ===
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the ProSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

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

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Installing AWS Instance with CloudFormation Template ==
AWS CloudFormation is a service that helps you model and set up your AWS resources so that you can spend less time managing those resources and more time focusing on your applications that run in AWS. Telcobridge created a CloudFormation template to reduce the time spent on ProSBC AWS installation. Click on the following link to the ProSBC CloudFormation installation:
[[TSBC-SW:WebPortal:ProSBC CloudFormation Installation|ProSBCAWS CloudFormation Installation]]

== Upgrading the instance type ==
You can upgrade the instance type in AWS based on your requirements. Click on the following link for instance type upgrade
[[TSBC-SW:WebPortal:ProSBC Instance Upgrade|ProSBC AWS Intance Upgrade]]

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]
[[Category:Revise on Major]]

== External References ==
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]

Configuring SIP Registration for regular NAP

2023-12-26T15:26:13Z

Serdar Civici:

{{DISPLAYTITLE:Configuring SIP Registration for regular NAP}}

{| class="wikitable"
|-
|rowspan="2"|This article applies to:
|'''Product'''
|'''Version'''
|-
|SBC
|3.0
|}

A regular NAP is a NAP with a specific Proxy address (either IP address or FQDN from 3.1 onward). Configuring SIP Registration for a regular NAP requires no extra steps. A NAP that accepts SIP registration must be a Registrar. A Registrar accepts SIP registration requests from ProSBC after ProSBC receives the request from a remote SIP end point that wants to register on the registrar.

You must configure SIP Registration Domain(s) for your regular NAP and associate them with the regular NAP (Registrar).

To create a new NAP:

1- Click '''NAPs''' in the navigation panel

[[Image:NAP_NavigationMenu.png]]

2- Click '''Create New NAP'''

[[Image:Create_New_NAP_SIP.png]]

3- Create the new NAP:

* Enter a '''name''' for the NAP
* Click '''Create'''

[[Image:SIP_Server_NAP_Create.png]]

4- Verify that the '''NAP was successfully created''' message appears

[[Image:Create_New_NAP_SIP2.png]]

5- Associate a SIP transport server with the new NAP:

* Select a '''SIP Transport Server''' from the '''Available''' list
* Click '''"<<"''' to associate the '''LAN_SIP_TS''' with the NAP

[[Image:SIP_Server_NAP_Create_1.png]]

6- Enter SIP Server proxy address:

[[Image:SIP_Server_NAP_Create_2.png]]

7- Associate a Port range with the new NAP:

* Select a '''port range''' from the '''Available''' list
* Click '''"<<"''' to associate '''LAN_Vlan:0''' Port range with the NAP

[[Image:SIP_Server_NAP_Create_3.png]]

8- Associate a SIP Domain with the new NAP. If you have more then 1 registrar domain using the same registrar you can associate all of them with the NAP:

* Select a '''sip domain''' from the '''Available''' list
* Click '''"<<"''' to associate the SIP Domain with the NAP

[[Image:Open_NAP_Create_3.png]]

9- Configure settings for the following parameter groups as required:
*Registration Parameters
*Authentication Parameters
*Network Address Translation
*SIP-I Parameters
*Advanced Parameters

*Click '''Save'''

[[Image:SIP_Server_NAP_Create_4.png]]

* '''Note:''' If you are using multiple registrations to the same destination with different ports, you must add the port number in the '''Address to register''' too.

[[Image:different_port.png]]

Configuring SIP Registration for regular NAP

2023-12-26T15:25:45Z

Serdar Civici:

Configuring SIP Registration for regular NAP

2023-12-26T15:23:32Z

Serdar Civici:

{{DISPLAYTITLE:Configuring SIP Registration for regular NAP}}

{| class="wikitable"
|-
|rowspan="2"|This article applies to:
|'''Product'''
|'''Version'''
|-
|SBC
|3.0
|}

A regular NAP is a NAP with a specific Proxy address (either IP address or FQDN from 3.1 onward). Configuring SIP Registration for a regular NAP requires no extra steps. A NAP that accepts SIP registration must be a Registrar. A Registrar accepts SIP registration requests from ProSBC after ProSBC receives the request from a remote SIP end point that wants to register on the registrar.

You must configure SIP Registration Domain(s) for your regular NAP and associate them with the regular NAP (Registrar).

To create a new NAP:

1- Click '''NAPs''' in the navigation panel

[[Image:NAP_NavigationMenu.png]]

2- Click '''Create New NAP'''

[[Image:Create_New_NAP_SIP.png]]

3- Create the new NAP:

* Enter a '''name''' for the NAP
* Click '''Create'''

[[Image:SIP_Server_NAP_Create.png]]

4- Verify that the '''NAP was successfully created''' message appears

[[Image:Create_New_NAP_SIP2.png]]

5- Associate a SIP transport server with the new NAP:

* Select a '''SIP Transport Server''' from the '''Available''' list
* Click '''"<<"''' to associate the '''LAN_SIP_TS''' with the NAP

[[Image:SIP_Server_NAP_Create_1.png]]

6- Enter SIP Server proxy address:

[[Image:SIP_Server_NAP_Create_2.png]]

7- Associate a Port range with the new NAP:

* Select a '''port range''' from the '''Available''' list
* Click '''"<<"''' to associate '''LAN_Vlan:0''' Port range with the NAP

[[Image:SIP_Server_NAP_Create_3.png]]

8- Associate a SIP Domain with the new NAP. If you have more then 1 registrar domain using the same registrar you can associate all of them with the NAP:

* Select a '''sip domain''' from the '''Available''' list
* Click '''"<<"''' to associate the SIP Domain with the NAP

[[Image:Open_NAP_Create_3.png]]

9- Configure settings for the following parameter groups as required:
*Registration Parameters
*Authentication Parameters
*Network Address Translation
*SIP-I Parameters
*Advanced Parameters

*Click '''Save'''

[[Image:SIP_Server_NAP_Create_4.png]]

* '''Note:''' If you are using multiple registrations to the same destination with different ports, you must add the port number in the Address to Register too. For example, want to register to 1.2.3.4 from port 5060 and 1.2.3.4 from 5062. In this case NAPs Address to Register parameters will be:

[[Image:different_port.png]]

File:Different port.png

2023-12-26T15:23:02Z

Serdar Civici:

Configuring SIP Registration for regular NAP

2023-12-26T15:22:51Z

Serdar Civici:

{{DISPLAYTITLE:Configuring SIP Registration for regular NAP}}

{| class="wikitable"
|-
|rowspan="2"|This article applies to:
|'''Product'''
|'''Version'''
|-
|SBC
|3.0
|}

A regular NAP is a NAP with a specific Proxy address (either IP address or FQDN from 3.1 onward). Configuring SIP Registration for a regular NAP requires no extra steps. A NAP that accepts SIP registration must be a Registrar. A Registrar accepts SIP registration requests from ProSBC after ProSBC receives the request from a remote SIP end point that wants to register on the registrar.

You must configure SIP Registration Domain(s) for your regular NAP and associate them with the regular NAP (Registrar).

To create a new NAP:

1- Click '''NAPs''' in the navigation panel

[[Image:NAP_NavigationMenu.png]]

2- Click '''Create New NAP'''

[[Image:Create_New_NAP_SIP.png]]

3- Create the new NAP:

* Enter a '''name''' for the NAP
* Click '''Create'''

[[Image:SIP_Server_NAP_Create.png]]

4- Verify that the '''NAP was successfully created''' message appears

[[Image:Create_New_NAP_SIP2.png]]

5- Associate a SIP transport server with the new NAP:

* Select a '''SIP Transport Server''' from the '''Available''' list
* Click '''"<<"''' to associate the '''LAN_SIP_TS''' with the NAP

[[Image:SIP_Server_NAP_Create_1.png]]

6- Enter SIP Server proxy address:

[[Image:SIP_Server_NAP_Create_2.png]]

7- Associate a Port range with the new NAP:

* Select a '''port range''' from the '''Available''' list
* Click '''"<<"''' to associate '''LAN_Vlan:0''' Port range with the NAP

[[Image:SIP_Server_NAP_Create_3.png]]

8- Associate a SIP Domain with the new NAP. If you have more then 1 registrar domain using the same registrar you can associate all of them with the NAP:

* Select a '''sip domain''' from the '''Available''' list
* Click '''"<<"''' to associate the SIP Domain with the NAP

[[Image:Open_NAP_Create_3.png]]

9- Configure settings for the following parameter groups as required:
*Registration Parameters
*Authentication Parameters
*Network Address Translation
*SIP-I Parameters
*Advanced Parameters

*Click '''Save'''

[[Image:SIP_Server_NAP_Create_4.png]]

* Note: If you are using multiple registrations to the same destination with different ports, you must add the port number in the Address to Register too. For example, want to register to 1.2.3.4 from port 5060 and 1.2.3.4 from 5062. In this case NAPs Address to Register parameters will be:

[[Image:different_port.png]]

TSBC-SW:WebPortal:ProSBC CloudFormation Installation

2023-11-20T22:44:55Z

Serdar Civici:

This page is intended to give assistance to people launching an instance of ProSBC using an AWS CloudFormation template.

Before starting to install, you must have a key pair for SSH access. Check the following link for how to create an AWS key Pair: [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html Create key pairs]

*[[File:CloudFormation_Json.zip|Click here to download CloudFormation JSON template]]

To load the JSON file please follow the procedure below:

1. Login to AWS with your account

2. Type CloudFormation in the search and select it

[[Image:Cloud_Formation_1.png|800px]]

3. Click on to Create Stack button

[[Image:Cloud_Formation_2.png|800px]]

4. Select Upload a template file and click on '''Choose File''' to select the file. When the upload is finished it will create an URL in the S3 Bucket for that file to store. Click to '''Next'''

[[Image:Cloud_Formation_3.png|800px]]

5. You will see the Stack Details Screen

[[Image:Cloud_Formation_4.png|800px]]
'''Stack Name:''' You need to enter a name for this newly created stack.
'''Instance Name:''' You need to enter a name for the instance that will created.
'''Instance Type:''' Need to select instance type. by default it is m5.large.
'''Key Name:''' EC2 KeyPair to enable SSH access to the instance.

6. Click '''Next''' until the '''Submit''' button.

TSBC-SW:WebPortal:ProSBC CloudFormation Installation

2023-11-20T22:44:16Z

Serdar Civici:

This page is intended to give assistance to people launching an instance of ProSBC using an AWS CloudFormation template.

Before starting to install, you must have a key pair for SSH access. Check the following link for how to create an AWS key Pair: [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html Create key pairs]

*[[Click here to download CloudFormation JSON template|File:CloudFormation_Json.zip]]

To load the JSON file please follow the procedure below:

1. Login to AWS with your account

2. Type CloudFormation in the search and select it

[[Image:Cloud_Formation_1.png|800px]]

3. Click on to Create Stack button

[[Image:Cloud_Formation_2.png|800px]]

4. Select Upload a template file and click on '''Choose File''' to select the file. When the upload is finished it will create an URL in the S3 Bucket for that file to store. Click to '''Next'''

[[Image:Cloud_Formation_3.png|800px]]

5. You will see the Stack Details Screen

[[Image:Cloud_Formation_4.png|800px]]
'''Stack Name:''' You need to enter a name for this newly created stack.
'''Instance Name:''' You need to enter a name for the instance that will created.
'''Instance Type:''' Need to select instance type. by default it is m5.large.
'''Key Name:''' EC2 KeyPair to enable SSH access to the instance.

6. Click '''Next''' until the '''Submit''' button.

ProSBC:Cloud:AWS Installation-B

2023-11-16T15:17:31Z

Serdar Civici:

{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
 
'''NOTE''' The old installation guide is here: [[FreeSBC:Cloud:AWS_Installation_A|AWS installation]]

== '''Instantiate a ProSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]

* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:
[[File:AWS EC2 AMIs.png|900px|thumb|center]]

* Launch the FreeSBC/ProSBC image.
[[File:EC2 launch AMI.png|900px|thumb|center]]

* Name the instance and add any necessary tag
[[File:EC2-AMI Launch.png|900px|thumb|center]]

* Select the instance type and its resources. The recommended instance type is:
** m5.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), M5 and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Calls per second (cps)
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass
|-
| valign="top" |
m5.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m5.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.2xlarge
| valign="top" |
8
| valign="top" |
575
| valign="top" |
2,000
| valign="top" |
60,000
|-
| valign="top" |
m5.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m5.12xlarge
| valign="top" |
48
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:EC2 AMI CPU.png|900px|thumb|center]]

* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.

[[File:EC2 AWS Key pair.png|900px|thumb|center]]

* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)

[[File:EC2 AMI Network.png|900px|thumb|center]]

* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2.

[[File:EC2 AMI Storage.png|900px|thumb|center]]

* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:

[[File:EC2 AMI Launch.png|900px|thumb|center]]

* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:

[[File:EC2 AMI Confirmation.png|900px|thumb|center]]

* After a few minutes your instance should be running and available to be configured:

[[File:EC2 AMI Instances.png|900px|thumb|center]]

=== Optional: Elastic IP Creation section ===
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommends associating an Elastic IP to your instance, which is, in short, to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].

== Enable SR-IOV enhanced networking ==
By default M5 instances have enhanced networking enabled. If you want to use any other instance, like m4 type instance, you need to check if enahnced networking is enabled or not.

It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.

This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''

There are two types of enhanced networking, we need the second one.

1) Elastic Network Adapter (ENA)

2) Intel 82599 Virtual Function (VF) interface

===Install the AWS CLI===
https://aws.amazon.com/cli/

===Get security credentials for the command line===
On the AWS web portal, click on your account name and choose "My Security Credentials"

Expand the "Access keys" section

Create a new key, you will need the AWSAccessKeyId and AWSSecretKey

===Open a CLI and execute the aws cli commands===
aws configure

Paste the access key ID and key that you previously obtained along with your default region.

===Show if the enhanced networking is enabled===
Make sure to replace the example instance ID with your own AWS instance ID

aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport

Enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {
"Value": "simple"
}
}

Not enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {}
}

To enable the sriov enhanced networking, first turn off the instance then do:

aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple

== Accessing the ProSBC ==
=== Accessing the ProSBC web portal ===
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the ProSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

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

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Installing AWS Instance with CloudFormation Template ==
AWS CloudFormation is a service that helps you model and set up your AWS resources so that you can spend less time managing those resources and more time focusing on your applications that run in AWS. Telcobridge created a CloudFormation template to reduce the time spent on ProSBC AWS installation. Click on the following link to the ProSBC CloudFormation installation:
[[TSBC-SW:WebPortal:ProSBC CloudFormation Installation|ProSBCAWS CloudFormation Installation]]

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]
[[Category:Revise on Major]]

== External References ==
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]

ProSBC:Cloud:AWS Installation-B

2023-11-16T15:15:29Z

Serdar Civici:

{{DISPLAYTITLE:ProSBC:Cloud:AWS Installation}}

This page is intended to give assistance to people launching an instance of ''ProSBC'' using an Amazon Machine Image (AMI) on Amazon Web Service (AWS).
 
'''NOTE''' The old installation guide is here: [[FreeSBC:Cloud:AWS_Installation_A|AWS installation]]

== '''Instantiate a ProSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:AWS Management Console 2022-07-28 16-27-37.png|900px|thumb|center]]

* Be sure you are in the correct region, on the left menu click on “AMIs” and select “Private image” to locate FreeSBC/ProSBC AMI:
[[File:AWS EC2 AMIs.png|900px|thumb|center]]

* Launch the FreeSBC/ProSBC image.
[[File:EC2 launch AMI.png|900px|thumb|center]]

* Name the instance and add any necessary tag
[[File:EC2-AMI Launch.png|900px|thumb|center]]

* Select the instance type and its resources. The recommended instance type is:
** m5.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), M5 and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
* This is the list of approximate performances for different AWS instance types. Results may vary according to configuration.
{| cellpadding="5" border="1" class="wikitable"
|-
! width="150" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | EC2 Instance
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | AWS CPU cores
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Calls per second (cps)
! width="100" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with RTP anchoring
! width="200" style="background: none repeat scroll 0% 0% rgb(239, 239, 239); -moz-background-inline-policy: continuous;" | Sessions with Media bypass
|-
| valign="top" |
m5.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m5.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.xlarge
| valign="top" |
4
| valign="top" |
215
| valign="top" |
750
| valign="top" |
60,000
|-
| valign="top" |
c4.2xlarge
| valign="top" |
8
| valign="top" |
575
| valign="top" |
2,000
| valign="top" |
60,000
|-
| valign="top" |
m5.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m5.10xlarge
| valign="top" |
40
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:EC2 AMI CPU.png|900px|thumb|center]]

* For later access to the FreeSBC/ProSBC SSH console you will need to select a Key Pair to secure the login. You can also create a new Key Pair in case you need.

[[File:EC2 AWS Key pair.png|900px|thumb|center]]

* In "Networking Settings" select "Create security group". We recommend that you simply open "All Traffic" on your own IP addresses to whitelist it in AWS firewall on "Source", once all your IPs are listed click on "Add security group rule": (note that the SBC contains its own internal firewall)

[[File:EC2 AMI Network.png|900px|thumb|center]]

* In "Configure Storage" change the Volume Size to 40Gb and select volume type to GP2.

[[File:EC2 AMI Storage.png|900px|thumb|center]]

* Finally review the summary of your instance and start the creation process clicking on "Launch Instance". Be aware, from this moment you will be billed by Amazon for the instance resources:

[[File:EC2 AMI Launch.png|900px|thumb|center]]

* You should receive the confirmation of the launching process, this process will take some minutes until the instance is available, You can view your instance clicking on “View Instances”:

[[File:EC2 AMI Confirmation.png|900px|thumb|center]]

* After a few minutes your instance should be running and available to be configured:

[[File:EC2 AMI Instances.png|900px|thumb|center]]

=== Optional: Elastic IP Creation section ===
* AWS will automatically provide and allocate a dynamic public IP to your instance, this will allow you to access from the IPs you whitelisted before to the Public IP allocated to your instance. For ProSBC servers the purpose is to interact with other SIP elements as part of a VoIP cloud telecom infrastructure, TelcoBridges strongly recommends associating an Elastic IP to your instance, which is, in short, to associate a fixed public IP to your SBC. For more information about how to associate an Elastic IP to your instance please check the official documentation in AWS [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html here].

== Enable SR-IOV enhanced networking ==
By default M5 instances have enhanced networking enabled. If you want to use any other instance, like m4 type instance, you need to check if enahnced networking is enabled or not.

It is very important to enable "enhanced networking" for tbrouter to have access to the network devices on the VM.

This must be done before completing the initial web portal configuration. '''Please shut down the instance before entering the serial number and all other information and set SR-IOV'''

There are two types of enhanced networking, we need the second one.

1) Elastic Network Adapter (ENA)

2) Intel 82599 Virtual Function (VF) interface

===Install the AWS CLI===
https://aws.amazon.com/cli/

===Get security credentials for the command line===
On the AWS web portal, click on your account name and choose "My Security Credentials"

Expand the "Access keys" section

Create a new key, you will need the AWSAccessKeyId and AWSSecretKey

===Open a CLI and execute the aws cli commands===
aws configure

Paste the access key ID and key that you previously obtained along with your default region.

===Show if the enhanced networking is enabled===
Make sure to replace the example instance ID with your own AWS instance ID

aws ec2 describe-instance-attribute --instance-id i-0123456789abcdef1 --attribute sriovNetSupport

Enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {
"Value": "simple"
}
}

Not enabled:
{
"InstanceId": "i-0123456789abcdef1",
"SriovNetSupport": {}
}

To enable the sriov enhanced networking, first turn off the instance then do:

aws ec2 modify-instance-attribute --instance-id i-0123456789abcdef1 --sriov-net-support simple

== Accessing the ProSBC ==
=== Accessing the ProSBC web portal ===
* Open a web browser to the management IP of the ProSBC, on port 12358. Example if your Instance public IP address is 35.183.126.193, the URL would be: http://35.183.126.193:12358
 
:You should get to the ProSBC Configuration Wizard 
:[[File:AWS_TSBC_WebPortal_Configuration_wizard.jpg|700px]]
 

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

* From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation.

== Installing AWS Instance with CloudFormation Template ==
AWS CloudFormation is a service that helps you model and set up your AWS resources so that you can spend less time managing those resources and more time focusing on your applications that run in AWS. Telcobridge created a CloudFormation template to reduce the time spent on ProSBC AWS installation. Click on the following link to the ProSBC CloudFormation installation:
[[TSBC-SW:WebPortal:ProSBC CloudFormation Installation|ProSBCAWS CloudFormation Installation]]

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal:Initial Configuration|ProSBC Initial Configuration]]

== Troubleshooting ==
* [[FreeSBC:Cloud:AWS_Installation_Troubleshooting_A|Installation troubleshooting]]
* [[FreeSBC:Cloud:Recovering_an_Elastic_IP_address|Recovering an Elastic IP address]]
[[Category:Revise on Major]]

== External References ==
* [https://devops.profitbricks.com/tutorials/use-ssh-keys-with-putty-on-windows/#connect-to-server-with-private-key Accessing device with SSH and private key using putty]

File:CloudFormation Json.zip

2023-11-14T14:56:00Z

Serdar Civici:

TSBC-SW:WebPortal:ProSBC CloudFormation Installation

2023-11-14T14:55:39Z

Serdar Civici: