TBwiki - User contributions [en]

FreeSBC:Cloud:AWS Installation A

2021-03-31T17:21:08Z

Jean-Pierre Marcil: /* Accessing the TSBC-SW */

{{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).

== '''Instantiate a ProSBC''' ==
* After logging in your Amazon account, click on “EC2” in the main AWS console:
[[File:ConsoleEC2.png| 600px]]

* On the left menu, click on “AMIs”:
[[File:AMIs.png| 100px]]

* Click on the filter drop list and select “Private image” to locate ProSBC AMI:
[[File:PrivateImages.png| 500px]]

* Select the region matching the region of the ProSBC AMI you want to test. If you don't know it, try "Canada (Central)".

[[File:RegionAMI.png| 700px]]

* Select the image and click “Launch”:
[[File:SelectAMI.png| 700px]]

* Select the instance type and its resources. The recommended instance type is:
** m4.large (2 vCPU, 8 GiB)
* Supported instance type are:
** C3, C4, D2, I2, M4 (excluding m4.16xlarge), and R3 instances ([https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html Supported instances from Amazon documentation])
*** Note: The Paris region is not supported at this time, since it does not have any of the supported instance types.
* 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;" | Sessions/s
! 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" |
m4.large
| valign="top" |
2
| valign="top" |
50
| valign="top" |
400
| valign="top" |
32,000
|-
| valign="top" |
m4.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" |
m4.4xlarge
| valign="top" |
16
| valign="top" |
650
| valign="top" |
4,000
| valign="top" |
60,000
|-
| valign="top" |
m4.10xlarge
| valign="top" |
40
| valign="top" |
650
| valign="top" |
4,800
| valign="top" |
60,000
|-
|}

[[File:SelectResources.png| 800px]]

* Click “Add Storage” to proceed to the next page:
[[File:ChooseSubnet.png| 1000px]]

* Change the Volume Size to 40Gb.
* Select "Volume Type": gp2
* Check the box "Delete on Termination"
* Click “Add Tags” to proceed to the next page.
[[File:NextTag.png| 800px]]

* You can leave the default parameters as they are.
* Click “Configure Security Group” to proceed to the next page:
[[File:NextSecurityGroup.png| 800px]]

* Select "Create a new security group". We recommend that you simply open all ports on your own IP address, since the SBC contains its own internal firewall:

{| class="wikitable"
|-
! Rule !! Type !! Port Range !! Source IP
|-
| All traffic || All traffic || 0 - 65535 || (Use your own public IP)
|}
[[File:AddRule.png| 600px ]]

* Click “Launch”. Be aware: you will be billed by Amazon for the instance resources:
[[File:Launch.png| 1000px]]

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

* Click on “Launch Instances”:
[[File:LaunchWithKey.png| 800px]]

* You can view your instance by clicking on “View Instances”:
[[File:ViewInstance.png| 800px]]

* Select the instance you just created and feel free to give it a name:
[[File:RenameInstance.png| 800px]]

=== Optional: Elastic IP Creation section ===
* If you want to use an associate public IP generated by Amazon (called "Elastic IP"). Click on "Elastic IP" on the left, then click on "Allocate new address":
[[File:ElasticIP.png| 300px]]

* Click on "Allocate IP". A new public IP will be generated by Amazon:
[[File:AllocateIP.png| 600px]]

* Click on "Close":
[[File:NewIP.png| 600px]]

=== Optional: Elastic IP association section ===

* Go to the left pane and click on "Instance". Then select the instance "ProSBC" to display its description:
[[File:IPforInstance.png| 600px]]

* Find the '''eth0''' network interface in the instance description:
[[File:GetTheRightNetworkInterface.png| 1100px]]

* Click on the '''eth0''' Network Interface, then click on the "Interface ID" link:
[[File:InterfaceID.png| 1100px]]

* Right-click on the selected Network Interface, then click "Associate Address":
[[File:AssociateAddress.png| 800px]]

* In the Address list, select the public IP to associate with the main Network Interface. Then, click on "Associate Address":
[[File:SelectAddress.png| 800px]]

* Click on "Instances" on the left pane and select "ProSBC" instance. Check if your instance is associated with a public IP:
[[File:Ready.png| 1100px]]

== Enable SR-IOV enhanced networking ==
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.

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": {}
}

==Enable sriov enhanced networking==
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 TSBC-SW ==
=== Accessing the TSBC-SW web portal ===
* Open a web browser to the management IP of the TSBC, 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 TSBC 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.

== Web Portal Initial Configuration ==
Click on the following link to pursue installation from the web portal:
[[TSBC-SW:WebPortal: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]

FreeSBC:Cloud:VmWare Installation A

2017-10-05T18:42:43Z

Jean-Pierre Marcil: Moving to 2 sub pages the Launching with vSphere or with web.

FreeSBC:Cloud:VmWare Installation A

2017-10-05T18:37:43Z

Jean-Pierre Marcil: Adding Latency sensitivity to Requirements

{{DISPLAYTITLE:TSBC-SW:Cloud:VmWare Installation}}
== Requirements ==
Minimal Cloud requirements:
* Vmware ESX 5 or 6
* 64 bits infrastructures only
* 4 vCPU
* 20G hard drive
* 8G RAM
* E1000 NIC emulation or VMXNET3 interfaces
* One Ethernet adapter for management
* One or more Ethernet adapter(s) for data

For better performance (see [[TSBC-SW:Cloud:VmWare_Optimizations|optimization]] section)
* CPU resource: allocation shares set to 'high'
* CPU resource: reservation set to maximum and no limit (i.e. 'unlimited')
* Memory resource: reserve all guest memory (all locked)
* Disk: shares 'high'
* Advanced CPU: Hyperthread core sharing to 'None'
* Latency Sensitivity: 'High'

== Getting the Image ==
Please contact our sales team at sales@telcobridges.com to get a copy of the latest TBSC Image.

== Installation on VmWare cloud ==

=== TBSC VmWare Image ===
A virtual machine image is a single file that contains a virtual disk that has a bootable operating system installed on it. Images are used to create virtual machine instances within the cloud.

You will need to upload the latest TSBC image into your VmWare before you can launch a virtual machine instance running the TSBC software.

==== Launching an instance ====

#Log in using the Vmware infrastructure client interface
#Select File->Deploy OVF Template... from the menu [[File:vmware_upload.png|400px]]
#Browse to the location of the TSBC-SW image obtained from TelcoBridges [[File:vmware_ovf_location.png|400px]]
# Click 'Next' until you need to name the new virtual machine instance. Enter the name and click 'Next' [[File:vmware_name.png|400px]]
# Select a datastore (if more than one are available) and select "Thick Provision Lazy Zeroed" as the disk format then click 'Next' [[File:vmware_disk.png|400px]]
# Accept all other default settings and wait until the machine is deployed. [[File:vmware_installing.png|200px]]
# Once deployed, right-click on the new instance and select "Edit Settings..." [[File:vmware_settings.png|400px]]
# Press the 'OK' button [[File:Vmware_restricted.png]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'OK' button yet. [[File:vmware_network.png|400px]]
# Go to the 'Resources' tab and select the CPU item. Set 'Shares' to 'high', slide the 'Reservation' cursor to the max (i.e. right) and make sure the 'Unlimited' option is checked-marked. Do '''not''' press the 'OK' button yet. [[File:vmware_cpu.png|400px]]
# Select the 'Memory' item and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'OK' button yet. [[File:vmware_mem.png|400px]]
# Select the 'Disk' item and set the 'Shares' to 'High'. Do '''not''' press the 'OK' button yet. [[File:vmware_disk_res.png|400px]]
# Select the 'Advanced CPU' item and set the 'Mode' to 'None'. Do '''not''' press the 'OK' button yet. [[File:vmware_adv_cpu.png|400px]]
# Press the 'OK' button
# Back to the main screen, select the newly instantiated virtual machine, right-click and select "Power-->Power On" to start it. [[File:vmware_poweron.png|400px]]
# Again to the main screen, select the newly instantiated virtual machine and choose the 'Summary' tab. Once the virtual machine is completed booted, the assigned DHCP IP address will be displayed by clicking on the 'View all' button. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_ip.png|400px]]

=== Accessing the TSBC-SW ===

==== Accessing the TSBC-SW web portal ====
# Open a web browser to the management IP of the TSBC, on port 12358. Example if your server address is 10.0.0.79, the URL would be: http://10.0.0.79:12358
# You should get to the TSBC Configuration Wizard [[File:TSBC_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation, and/or [[TSBC-SW:Baremetal:VmWare_Optimizations|optimize ]] your server to get the maximum out of your server.

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

== Optimizations ==
Click on the following link for VmWare optimizations:
[[TSBC-SW:Cloud:VmWare_Optimizations]]

TSBC-SW:Cloud:VmWare Launching Instance vSphere A

2017-10-05T18:36:18Z

Jean-Pierre Marcil: Creating a new page for the vSphere section of vmware Installation

==== Launching an instance the vSphere fat client ====

#Log in using the Vmware infrastructure client interface
#Select File->Deploy OVF Template... from the menu [[File:vmware_upload.png|400px]]
#Browse to the location of the TSBC-SW image obtained from TelcoBridges [[File:vmware_ovf_location.png|400px]]
# Click 'Next' until you need to name the new virtual machine instance. Enter the name and click 'Next' [[File:vmware_name.png|400px]]
# Select a datastore (if more than one are available) and select "Thick Provision Lazy Zeroed" as the disk format then click 'Next' [[File:vmware_disk.png|400px]]
# Accept all other default settings and wait until the machine is deployed. [[File:vmware_installing.png|200px]]
# Once deployed, right-click on the new instance and select "Edit Settings..." [[File:vmware_settings.png|400px]]
# Press the 'OK' button [[File:Vmware_restricted.png]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'OK' button yet. [[File:vmware_network.png|400px]]
# Go to the 'Resources' tab and select the CPU item. Set 'Shares' to 'high', slide the 'Reservation' cursor to the max (i.e. right) and make sure the 'Unlimited' option is checked-marked. Do '''not''' press the 'OK' button yet. [[File:vmware_cpu.png|400px]]
# Select the 'Memory' item and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'OK' button yet. [[File:vmware_mem.png|400px]]
# Select the 'Disk' item and set the 'Shares' to 'High'. Do '''not''' press the 'OK' button yet. [[File:vmware_disk_res.png|400px]]
# Select the 'Advanced CPU' item and set the 'Mode' to 'None'. Do '''not''' press the 'OK' button yet. [[File:vmware_adv_cpu.png|400px]]
# Set the 'Latency Sensitivity' to 'High'
# Press the 'OK' button
# Back to the main screen, select the newly instantiated virtual machine, right-click and select "Power-->Power On" to start it. [[File:vmware_poweron.png|400px]]
# Again to the main screen, select the newly instantiated virtual machine and choose the 'Summary' tab. Once the virtual machine is completed booted, the assigned DHCP IP address will be displayed by clicking on the 'View all' button. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_ip.png|400px]]

File:Vmware web total mhz.png

2017-10-05T18:30:25Z

Jean-Pierre Marcil:

TSBC-SW:Cloud:VmWare Launching Instance Web A

2017-10-05T18:30:13Z

Jean-Pierre Marcil: Adjusting some screenshot width

== Launching an instance using ESXi web interface ==

# Log in using the Vmware web interface
# Select 'Virtual Machines' from the left menu [[File:vmware_web_virtual_machines.png|200px]]
# Click on 'Create / Register VM' [[File:vmware_web_create.png|400px]]
# Select 'Deploy a virtual machine from an OVF or OVA file' then press 'next' [[File:vmware_web_select_type.png|400px]]
# Enter the name. Drag the file or browse to the location of the TSBC-SW image obtained from TelcoBridges. 'Click 'Next' [[File:vmware_web_browse_ova.png|400px]]
# Select a datastore (if more than one are available) then click 'Next' [[File:vmware_web_select_storage.png|400px]]
# Choose your network. Select 'Thick' disk provisioning. Uncheck 'Power on automatically'. Click 'Next' [[File:vmware_web_deployment_options.png|400px]]
# Click 'Next' [[File:vmware_web_ready_to_complete.png|400px]]
# Do not refresh your browser and wait until the machine is deployed. [[File:vmware_web_installing.png|400px]]
# Once deployed, edit the VM [[File:vmware_web_edit_settings.png|400px]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'Save' button yet. [[File:vmware_web_network.png|400px]]
# Click on 'CPU' to open the details. Set 'Shares' to 'high', enter the maximum number of MHz corresponding to your number of CPU cores in 'Reservation' (See [[TSBC-SW:Cloud:VmWare_Launching_Instance_Web_A#Calculating_Reserved_CPU_MHz|Calculating Reserved CPU]]) and make sure the 'Unlimited' option is selected. Do '''not''' press the 'Save' button yet. [[File:vmware_web_cpu.png|400px]]
# Open the 'Memory' details and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'Save' button yet. [[File:vmware_web_memory.png|400px]]
# Open the 'Hard disk 1' details and set the 'Shares' to 'High'. Do '''not''' press the 'Save' button yet. [[File:vmware_web_disk_res.png|400px]]
# Click on the second tab 'VM Options', expand 'Advanced' and set 'Latency Sensitivity' to 'High' then press the 'Save' button. [[File:vmware_web_latency.png|400px]]
# Back to the main screen, click on "Power On" to start the new VM. [[File:vmware_web_poweron.png|400px]]
# Once the VM had completely booted, its assigned DHCP IPs will be displayed in General Information -> Networking. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_web_ip.png|400px]]

=== Calculating Reserved CPU MHz ===
To get the MHz per core, you need to figure out the total number of available MHz that your system has and divide by the total number of cores.
# Select 'Host' on the left menu [[File:vmware_web_host.png|200px]]
# Take note of the number of cores this system has. (In this example: 12) Also take a look at the 'CAPACITY', but is is not precise down to the MHz (In this example 36.7 GHz) [[File:vmware_web_total_cpus.png|400px]]
# When editing the VM, in the disk details, expand the 'Reservation' combobox. There should be a number in exact MHz for the maximum capacity of the system (In this example: 36708) [[File:vmware_web_total_mhz.png|400px]]
# Calculate your VM CPU MHz Reservation requirement
::mhz_per_core = total_system_mhz / total_system_cpus (In this example: 3059 = 36708 / 12 )
::vm_reserved_mhz = vm_cpus * mhz_per_core (In this example: 12236 = 3059 * 4 )

File:Vmware web total cpus.png

2017-10-05T18:28:25Z

Jean-Pierre Marcil:

File:Vmware web host.png

2017-10-05T18:28:06Z

Jean-Pierre Marcil:

File:Vmware web ip.png

2017-10-05T18:27:45Z

Jean-Pierre Marcil:

File:Vmware web poweron.png

2017-10-05T18:27:25Z

Jean-Pierre Marcil:

File:Vmware web latency.png

2017-10-05T18:27:03Z

Jean-Pierre Marcil:

File:Vmware web disk res.png

2017-10-05T18:26:36Z

Jean-Pierre Marcil:

File:Vmware web memory.png

2017-10-05T18:26:04Z

Jean-Pierre Marcil:

File:Vmware web cpu.png

2017-10-05T18:25:34Z

Jean-Pierre Marcil:

File:Vmware web network.png

2017-10-05T18:25:12Z

Jean-Pierre Marcil:

File:Vmware web edit settings.png

2017-10-05T18:23:31Z

Jean-Pierre Marcil:

File:Vmware web installing.png

2017-10-05T18:23:13Z

Jean-Pierre Marcil:

File:Vmware web ready to complete.png

2017-10-05T18:22:47Z

Jean-Pierre Marcil:

File:Vmware web deployment options.png

2017-10-05T18:22:22Z

Jean-Pierre Marcil:

File:Vmware web select storage.png

2017-10-05T18:22:05Z

Jean-Pierre Marcil:

File:Vmware web browse ova.png

2017-10-05T18:21:33Z

Jean-Pierre Marcil:

File:Vmware web select type.png

2017-10-05T18:21:00Z

Jean-Pierre Marcil:

File:Vmware web create.png

2017-10-05T18:20:38Z

Jean-Pierre Marcil:

File:Vmware web virtual machines.png

2017-10-05T18:20:05Z

Jean-Pierre Marcil:

TSBC-SW:Cloud:VmWare Launching Instance Web A

2017-10-05T18:18:23Z

Jean-Pierre Marcil: Adding Calculating Reserved CPU Mhz section

== Launching an instance using ESXi web interface ==

# Log in using the Vmware web interface
# Select 'Virtual Machines' from the left menu [[File:vmware_web_virtual_machines.png|400px]]
# Click on 'Create / Register VM' [[File:vmware_web_create.png|400px]]
# Select 'Deploy a virtual machine from an OVF or OVA file' then press 'next' [[File:vmware_web_select_type.png|400px]]
# Enter the name. Drag the file or browse to the location of the TSBC-SW image obtained from TelcoBridges. 'Click 'Next' [[File:vmware_web_browse_ova.png|400px]]
# Select a datastore (if more than one are available) then click 'Next' [[File:vmware_web_select_storage.png|400px]]
# Choose your network. Select 'Thick' disk provisioning. Uncheck 'Power on automatically'. Click 'Next' [[File:vmware_web_deployment_options.png|400px]]
# Click 'Next' [[File:vmware_web_ready_to_complete.png|400px]]
# Do not refresh your browser and wait until the machine is deployed. [[File:vmware_web_installing.png|400px]]
# Once deployed, edit the VM [[File:vmware_web_edit_settings.png|400px]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'Save' button yet. [[File:vmware_web_network.png|400px]]
# Click on 'CPU' to open the details. Set 'Shares' to 'high', enter the maximum number of MHz corresponding to your number of CPU cores in 'Reservation' (See [[TSBC-SW:Cloud:VmWare_Launching_Instance_Web_A#Calculating_Reserved_CPU_MHz|Calculating Reserved CPU]]) and make sure the 'Unlimited' option is selected. Do '''not''' press the 'Save' button yet. [[File:vmware_web_cpu.png|400px]]
# Open the 'Memory' details and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'Save' button yet. [[File:vmware_web_memory.png|400px]]
# Open the 'Hard disk 1' details and set the 'Shares' to 'High'. Do '''not''' press the 'Save' button yet. [[File:vmware_web_disk_res.png|400px]]
# Click on the second tab 'VM Options', expand 'Advanced' and set 'Latency Sensitivity' to 'High' then press the 'Save' button. [[File:vmware_web_latency.png|400px]]
# Back to the main screen, click on "Power On" to start the new VM. [[File:vmware_web_poweron.png|400px]]
# Once the VM had completely booted, its assigned DHCP IPs will be displayed in General Information -> Networking. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_web_ip.png|400px]]

=== Calculating Reserved CPU MHz ===
To get the MHz per core, you need to figure out the total number of available MHz that your system has and divide by the total number of cores.
# Select 'Host' on the left menu [[File:vmware_web_host.png|400px]]
# Take note of the number of cores this system has. (In this example: 12) Also take a look at the 'CAPACITY', but is is not precise down to the MHz (In this example 36.7 GHz) [[File:vmware_web_total_cpus.png|400px]]
# When editing the VM, in the disk details, expand the 'Reservation' combobox. There should be a number in exact MHz for the maximum capacity of the system (In this example: 36708) [[File:vmware_web_total_cpus.png|400px]]
# Calculate your VM CPU MHz Reservation requirement
::mhz_per_core = total_system_mhz / total_system_cpus (In this example: 3059 = 36708 / 12 )
::vm_reserved_mhz = vm_cpus * mhz_per_core (In this example: 12236 = 3059 * 4 )

TSBC-SW:Cloud:VmWare Launching Instance Web A

2017-10-05T16:55:35Z

Jean-Pierre Marcil: fix link

== Launching an instance using ESXi web interface ==

# Log in using the Vmware web interface
# Select 'Virtual Machines' from the left menu [[File:vmware_web_virtual_machines.png|400px]]
# Click on 'Create / Register VM' [[File:vmware_web_create.png|400px]]
# Select 'Deploy a virtual machine from an OVF or OVA file' then press 'next' [[File:vmware_web_select_type.png|400px]]
# Enter the name. Drag the file or browse to the location of the TSBC-SW image obtained from TelcoBridges. 'Click 'Next' [[File:vmware_web_browse_ova.png|400px]]
# Select a datastore (if more than one are available) then click 'Next' [[File:vmware_web_select_storage.png|400px]]
# Choose your network. Select 'Thick' disk provisioning. Uncheck 'Power on automatically'. Click 'Next' [[File:vmware_web_deployment_options.png|400px]]
# Click 'Next' [[File:vmware_web_ready_to_complete.png|400px]]
# Do not refresh your browser and wait until the machine is deployed. [[File:vmware_web_installing.png|400px]]
# Once deployed, edit the VM [[File:vmware_web_edit_settings.png|400px]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'Save' button yet. [[File:vmware_web_network.png|400px]]
# Click on 'CPU' to open the details. Set 'Shares' to 'high', enter the maximum number of MHz corresponding to your number of CPU cores in 'Reservation' (See [[TSBC-SW:Cloud:VmWare_Launching_Instance_Web_A#Calculating_Reserved_CPU_MHz]]) and make sure the 'Unlimited' option is selected. Do '''not''' press the 'Save' button yet. [[File:vmware_web_cpu.png|400px]]
# Open the 'Memory' details and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'Save' button yet. [[File:vmware_web_memory.png|400px]]
# Open the 'Hard disk 1' details and set the 'Shares' to 'High'. Do '''not''' press the 'Save' button yet. [[File:vmware_web_disk_res.png|400px]]
# Click on the second tab 'VM Options', expand 'Advanced' and set 'Latency Sensitivity' to 'High' then press the 'Save' button. [[File:vmware_web_latency.png|400px]]
# Back to the main screen, click on "Power On" to start the new VM. [[File:vmware_web_poweron.png|400px]]
# Once the VM had completely booted, its assigned DHCP IPs will be displayed in General Information -> Networking. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_web_ip.png|400px]]

=== Calculating Reserved CPU MHz ===

TSBC-SW:Cloud:VmWare Launching Instance Web A

2017-10-05T16:54:36Z

Jean-Pierre Marcil: moved TSBC-SW:Cloud:VmWare Launching Instance Web to TSBC-SW:Cloud:VmWare Launching Instance Web A: Adding _A suffix to page name

== Launching an instance using ESXi web interface ==

# Log in using the Vmware web interface
# Select 'Virtual Machines' from the left menu [[File:vmware_web_virtual_machines.png|400px]]
# Click on 'Create / Register VM' [[File:vmware_web_create.png|400px]]
# Select 'Deploy a virtual machine from an OVF or OVA file' then press 'next' [[File:vmware_web_select_type.png|400px]]
# Enter the name. Drag the file or browse to the location of the TSBC-SW image obtained from TelcoBridges. 'Click 'Next' [[File:vmware_web_browse_ova.png|400px]]
# Select a datastore (if more than one are available) then click 'Next' [[File:vmware_web_select_storage.png|400px]]
# Choose your network. Select 'Thick' disk provisioning. Uncheck 'Power on automatically'. Click 'Next' [[File:vmware_web_deployment_options.png|400px]]
# Click 'Next' [[File:vmware_web_ready_to_complete.png|400px]]
# Do not refresh your browser and wait until the machine is deployed. [[File:vmware_web_installing.png|400px]]
# Once deployed, edit the VM [[File:vmware_web_edit_settings.png|400px]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'Save' button yet. [[File:vmware_web_network.png|400px]]
# Click on 'CPU' to open the details. Set 'Shares' to 'high', enter the maximum number of MHz corresponding to your number of CPU cores in 'Reservation' (See [[TSBC-SW:Cloud:VmWare_Launching_Instance_Web#Calculating_Reserved_CPU_MHz]]) and make sure the 'Unlimited' option is selected. Do '''not''' press the 'Save' button yet. [[File:vmware_web_cpu.png|400px]]
# Open the 'Memory' details and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'Save' button yet. [[File:vmware_web_memory.png|400px]]
# Open the 'Hard disk 1' details and set the 'Shares' to 'High'. Do '''not''' press the 'Save' button yet. [[File:vmware_web_disk_res.png|400px]]
# Click on the second tab 'VM Options', expand 'Advanced' and set 'Latency Sensitivity' to 'High' then press the 'Save' button. [[File:vmware_web_latency.png|400px]]
# Back to the main screen, click on "Power On" to start the new VM. [[File:vmware_web_poweron.png|400px]]
# Once the VM had completely booted, its assigned DHCP IPs will be displayed in General Information -> Networking. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_web_ip.png|400px]]

=== Calculating Reserved CPU MHz ===

TSBC-SW:Cloud:VmWare Launching Instance Web A

2017-10-05T16:53:18Z

Jean-Pierre Marcil: Creation

== Launching an instance using ESXi web interface ==

# Log in using the Vmware web interface
# Select 'Virtual Machines' from the left menu [[File:vmware_web_virtual_machines.png|400px]]
# Click on 'Create / Register VM' [[File:vmware_web_create.png|400px]]
# Select 'Deploy a virtual machine from an OVF or OVA file' then press 'next' [[File:vmware_web_select_type.png|400px]]
# Enter the name. Drag the file or browse to the location of the TSBC-SW image obtained from TelcoBridges. 'Click 'Next' [[File:vmware_web_browse_ova.png|400px]]
# Select a datastore (if more than one are available) then click 'Next' [[File:vmware_web_select_storage.png|400px]]
# Choose your network. Select 'Thick' disk provisioning. Uncheck 'Power on automatically'. Click 'Next' [[File:vmware_web_deployment_options.png|400px]]
# Click 'Next' [[File:vmware_web_ready_to_complete.png|400px]]
# Do not refresh your browser and wait until the machine is deployed. [[File:vmware_web_installing.png|400px]]
# Once deployed, edit the VM [[File:vmware_web_edit_settings.png|400px]]
# Edit network adapters to connect on proper networks. Make sure that at least one of the adapter connects to the private management network of the setup from which WebPortal access will be granted. Do '''not''' press the 'Save' button yet. [[File:vmware_web_network.png|400px]]
# Click on 'CPU' to open the details. Set 'Shares' to 'high', enter the maximum number of MHz corresponding to your number of CPU cores in 'Reservation' (See [[TSBC-SW:Cloud:VmWare_Launching_Instance_Web#Calculating_Reserved_CPU_MHz]]) and make sure the 'Unlimited' option is selected. Do '''not''' press the 'Save' button yet. [[File:vmware_web_cpu.png|400px]]
# Open the 'Memory' details and check-mark the 'Reserve all guest memory (All locked)' option. Do '''not''' press the 'Save' button yet. [[File:vmware_web_memory.png|400px]]
# Open the 'Hard disk 1' details and set the 'Shares' to 'High'. Do '''not''' press the 'Save' button yet. [[File:vmware_web_disk_res.png|400px]]
# Click on the second tab 'VM Options', expand 'Advanced' and set 'Latency Sensitivity' to 'High' then press the 'Save' button. [[File:vmware_web_latency.png|400px]]
# Back to the main screen, click on "Power On" to start the new VM. [[File:vmware_web_poweron.png|400px]]
# Once the VM had completely booted, its assigned DHCP IPs will be displayed in General Information -> Networking. Note this IP address to access the Web Portal configuration interface later. [[File:vmware_web_ip.png|400px]]

=== Calculating Reserved CPU MHz ===

FreeSBC:Cloud:OpenStack Installation A

2017-10-02T18:35:17Z

Jean-Pierre Marcil: /* Upload an Image */

{{DISPLAYTITLE:TSBC-SW:Cloud:OpenStack Installation}}
== Requirements ==
Minimal Cloud requirements:
* 64 bits infrastructures only
* 4 vCPU
* 20G hard drive
* 8G RAM
* Virtio NIC interface
* qemu-kvm CPU exposed as 'host' or minimally 'core2duo'
* One Ethernet adapter for management
* One or more Ethernet adapter(s) for data

For better performance (see [[TSBC-SW:Cloud:OpenStack_Optimizations|optimization]] section)
* SR-IOV or MacVTap compatible NICs
* Overcommit set to 1:1
* No CPU (including hyperthreading) shared between infrastructure and compute section
* Dedicated memory allocation to VM

== Getting the Image ==
Please contact our sales team at sales@telcobridges.com to get a copy of the latest TBSC Image.

== Installation on OpenStack cloud ==

=== TSBC OpenStack Minimal Flavor ===
In OpenStack, a flavor defines the compute, memory, and storage capacity of a virtual server, also known as an instance. If you do not already have a flavor that meets the listed minimal requirements, you will have to create a new one.

==== Creating a Flavor ====
#Log in to the Dashboard and select the '''admin''' project from the drop-down list.
#In the '''Admin''' tab, open the '''System''' tab and click the '''Flavors''' category.
#Click '''Create Flavor'''.
#In the '''Create Flavor''' window, enter or select the parameters for the flavor in the '''Flavor Information''' tab.
#* '''Name''' : ''TelcoBridges TSBC Flavor''
#* '''VCPUs''' : ''4''
#* '''RAM (MB)''' : ''8192''
#* '''Root Disk (GB)''' : ''20''
#* Other fields are left to their default value [[File:OpenStackMinimalFlavorCreate.png|500px]]
#In the '''Flavor Access''' tab, you can control access to the flavor by moving projects from the '''All Projects''' column to the '''Selected Projects''' column. Only projects in the '''Selected Projects''' column can use the flavor. If there are no projects in the right column, all projects can use the flavor.
#Click '''Create Flavor'''.

==== References ====
*https://docs.openstack.org/admin-guide/dashboard-manage-flavors.html
*https://docs.openstack.org/admin-guide/compute-flavors.html

=== TBSC OpenStack Image ===
A virtual machine image is a single file that contains a virtual disk that has a bootable operating system installed on it. Images are used to create virtual machine instances within the cloud.

You will need to upload the latest TSBC image into your OpenStack before you can launch a virtual machine instance running the TSBC software.

==== Upload an Image ====
Follow this procedure to upload an image to a project:
#Log in to the dashboard.
#Select the appropriate project from the drop down menu at the top left.
#On the Project tab, open the Compute tab and click Images category.
#Click Create Image.
#The Create An Image dialog box appears.
#Enter the following values:
#*'''Image Name''' : ''TelcoBridges TSBC xx.yy.zz'' (Where xxx.yy.zz is changed to the version number of the TSBC image)
#*'''Image Description''': ''TelcoBridges TSBC version xx.yy.zz''
#*'''Image Source''' : ''.qcow2 file. Must not be compressed (tar.gz)''.
#*'''Image File''' : Browse for the image file on your file system and add it.
#*'''Format''': ''QCOW2''
#*'''Architecture''': ''x86_64''
#*'''Minimum Disk (GB)''' : ''20''
#*'''Minimum RAM (MB)''': ''8192''
#*'''Visibility''' : The access permission for the image. ''Public'' or ''Private'', depending on your needs.
#*'''Protected''': Select this check box to ensure that only users with permissions can delete the image. ''Yes'' or ''No''. [[File:OpenStackImageUpload.png|500px]]
#Image Metadata : Leave empty.
#Click Create Image. The image is queued to be uploaded. It might take some time before the status changes from Queued to Active.

==== References ====
*https://docs.openstack.org/admin-guide/dashboard-manage-images.html

=== TSBC OpenStack Instance ===
Instances are virtual machines that run inside OpenStack's cloud. You will need to launch a new instance from the TSBC Image created in the [[#Upload an Image]] section

==== Launching an instance ====

#Log in to the dashboard.
#Select the appropriate project from the drop down menu at the top left.
#On the Project tab, open the Compute tab and click Instances category.
#The dashboard shows the instances with its name, its private and floating IP addresses, size, status, task, power state, and so on.
#Click Launch Instance.
#In the Launch Instance dialog box, specify the following values:
##<big>Details tab</big>
##*'''Instance Name''' : Assign a name to the virtual machine. For example: ''TelcoBridges TSBC''.
##*'''Availability Zone''' : By default, this value is set to the availability zone given by the cloud provider (for example, us-west or apac-south). For some cases, it could be nova.
##*'''Count''' : ''1'' [[File:OpenStackLaunchInstanceDetailsTab.png|500px]]
##<big>Source tab</big>
##*'''Instance Boot Source''' : ''Boot from image''.
##*'''Create new Volume''' : ''No''
##*'''Select Image Name''' : Select ''TelcoBridges TSBC xx.yy.zz'' as created in [[#Upload an Image]] section. [[File:OpenStackLaunchInstanceSourceTab.png|500px]]
##<big>Flavor tab</big>
##*'''Flavor''' : Select ''TelcoBridges TSBC Flavor'' as created in [[#Creating a Flavor]] section. [[File:OpenStackLaunchInstanceFlavorTab.png|500px]]
##<big>Networks tab</big>
##*'''Selected Networks''': If you are installing a '''standalone''' SBC, the TSBC will need access to ''WAN'' and ''MGMT'' networks. For transcoding on TSBC-TRANS, or HA pair installation, the TSBC will also need access to ''CTRL0'', ''CTRL1'' and ''TRANS0'' networks. Please refer to [[TSBC-SW:Networking]] for details on network requirements. '''Important''': For optimal performance, it is recommended to use SR-IOV or MacVTap ports to access ''LAN'' and ''WAN'' networks, see [[TSBC-SW:Cloud:OpenStack_Optimizations]] for details. [[File:OpenStackLaunchInstanceNetworkTab.png|500px]]
##<big>Network Ports tab</big>
##*'''Ports''' : For optimal performances, SR-IOV and MacVTap ports should be used to access ''LAN'' and ''WAN'' networks. If you do choose to use Network Ports to attach to ''LAN'' and ''WAN'' networks, do not attach to them in ''Networks Tabs''. See [[TSBC-SW:Cloud:OpenStack_Optimizations]] for details. [[File:OpenStackLaunchInstanceNetworkPortsTab.png|500px]]
##<big>Security Groups tab</big>
##*'''Security Groups''': Activate the security groups that you want to assign to the instance. Security groups are a kind of cloud firewall that define which incoming network traffic is forwarded to instances. If you have not created any security groups, you can assign only the default security group to the instance. '''Warning''': ''Make sure the selected security group allows ingress traffic''. [[File:OpenStackLaunchInstanceSecurityGroupTab.png|500px]]
##<big>Key Pair tab</big>
##*'''Key Pair''' : SSH access to the TSBC with a password is disabled by default on the TSBC. You will need to provide your SSH public key here in order to get SSH access into the TSBC. [[File:OpenStackLaunchInstanceKeyPairTab.png|500px]]
#Click Launch Instance. The TSBC instance will starts on a compute node in your cloud. When the instance state is changed to Active, you will be able to the TSBC using SSH or a web browser as described in the next section..

==== References ====
*https://docs.openstack.org/user-guide/dashboard-launch-instances.html

=== Accessing the TSBC-SW ===
==== TSBC SSH Access ====
There is no root password by default, you will need to SSH onto the TSBC using SSH private key matching the public provided in the '''Key Pair tab''' when [[#Launching an instance|Launching]] the TSBC instance. Login using ''tbcloud'' as username.

For example, if you TSBC management IP is 192.168.178.30:
> ssh tbcloud@192.168.178.30
ECDSA key fingerprint is 5d:94:a1:93:0f:a4:7a:5d:41:cc:29:49:79:5a:58:f3.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '192.168.178.30' (ECDSA) to the list of known hosts.

CentOS-7-x86_64-Minimal-1511/112/190195:197392, Fri 7 Apr 17:41:46 EDT 2017
[tbcloud@tsbc ~]$

==== Accessing the TSBC-SW web portal ====
# Open a web browser to the management IP of the TSBC, on port 12358. Example if your server address is 192.168.178.30, the URL would be: http://192.168.178.30:12358
# You should get to the TSBC Configuration Wizard [[File:TSBC_WebPortal_Configuration_wizard.jpg|350px]]

From here, you can go to [[TSBC-SW:WebPortal:Initial Configuration|Web Portal Initial Configuration Guide]] to continue the installation, and/or [[TSBC-SW:Baremetal:OpenStack_Optimizations|optimize ]] your server to get the maximum out of your server.

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

== Optimizations ==
Click on the following link for OpenStack optimizations:
[[TSBC-SW:Cloud:OpenStack_Optimizations]]