Cloud Platform User Manual
Edit your account details, add an SSH public key, and configure two-factor authentication.
After you log in, you may need to edit your user account to update your details:
Edit user general information
Edit user advanced
Two-factor authentication is the use of a password and a special authentication code to make the login process more secure. You may be required to enable it for your account, or you may be able to choose to enable it for your account. You can choose to receive your authentication codes from Google Authentication app or by email.
To enable two-factor authentication
During login, the platform will ask for the authentication code from the app or your email. Enter the code in the field below the password.
To create a virtual machine (VM) do the following steps:
The platform will create your VM. The status bar on the VM icon says it is NOT_ALLOCATED, which means that the VM has not been launched into the cloud.
The template tab contains compatible templates only. If you cannot see an expected template, contact your system administrator. If there are a lot of templates, you may wish to filter the templates first.
To filter templates in the left-hand Template library tab:
To clear the search
To configure your VM before you launch it, do the following steps:
To configure the basic general VM settings:
In public cloud you will need to:
Edit your user account to add an SSH public key. See Configure your user account. You will need the SSH private key to log in to your VM
Assign a public IP to your VM. See VM Network
You can now continue with further configuration or Save and deploy your VM.
If you don't add an IP, the platform will automatically add one on the default network.
To configure IP addresses on your VM
Select the firewall policies to add. You can add as many firewall policies as necessary, up to the cloud provider's limit. If you can't see the expected policies, you may need to synchronize with your provider or wait for the platform to update provider data
Select the load balancers to use for the VM.
To enable monitoring and metrics
In private cloud, you can create additional hard disks that are not persistent. This means that when you undeploy the VM or remove the hard disk, the platform will delete your hard disks and destroy all data on them. To store the contents of a hard disk, create an instance template that will copy the hard disk to the template library.
To add a hard disk:
Click the add button at the top right of the Storage tab
Select Assign virtual disk.
In the dialog the options will depend on the platform configuration
You must enter the size and the controller type
Note that you cannot change the size of the primary disk before you deploy a VM.
To launch your VMs, click the Deploy virtual appliance button on the right-hand side of the screen.
The platform will launch the VMs and power them on. The status bar below each VM icon will be coloured green. And the Deploy button changes to become the Undeploy button, which you can use to destroy the VMs.
To display VM details, select a VM icon. The platform will display the control panel below the VMs with different tabs, such as General and NICs.
Here are some examples of VM control panel tabs
To display VM metrics, click the metrics symbol on the VM icon.
To refresh metrics data, click the arrow refresh button on the right-hand side. To toggle the display of metrics, click the selection list symbol on the left-hand side, and select the desired metrics.
To filter metrics, click the funnel symbol. Enter the granularity, statistics, period, and dimensions.
To configure the display of metrics at the virtual appliance level, do these steps.
Screenshot: filtering metric statistics
Shutdown: The platform will try to gracefully shut down the VM. This option may require hypervisor and guest VM configuration
Power off: The platform will perform a hard power off on the virtualization technology. Warning: Using this option may cause loss of data
Remember that stopping a VM does not destroy it in the cloud provider and the VM is still consuming resources.
To power on a VM, click the play arrow start button.
Depending on the cloud provider, you may also be perform the following actions:
The platform displays the appropriate buttons for the provider and the current state of the VM.
The following screenshots show two VMs: the VM on the left is selected to perform an operation; the VM on the right shows how the result of the operation will look.
The platform enables you to connect to a console of a VM that is deployed and powered on.
To connect to your VM from the user interface:
The remote access connection to the VM will open and you can log in and work with the VM. Remember to change your administrator password as soon as possible.
When you add another VM to a deployed virtual appliance, it is not allocated to the provider directly. You can deploy new VMs individually or click the Deploy all VMs button in the top right-hand corner of the screen.
After you deploy a VM, the changes you can make will depend on your cloud provider. To change the configuration of a deployed VM
The changes will be applied in the cloud provider directly.
To change a VM's fully qualified domain name (FQDN), make the change in the VM's operating system and the platform will detect the new value
Do NOT change the Abiquo tag in public cloud
Do not change the Abiquo platform's tag on a VM in public cloud provider (e.g. on an AWS instance) because you could break the link between Abiquo and the VM. If the link is broken, you will not be able to manage the VM with Abiquo.
An Abiquo instance is a new template that you create from VM disks.
Before you begin:
To create an Abiquo instance, do these steps:
Your new templates will be stored in the Template library.
To use an instance template in a VM, double-click or drag and drop the original template and an instance menu will open. Select the instance template.
To display all VMs of your enterprise, go to Virtual datacenters → All virtual datacenters → Virtual machines tab.
To display all the VMs in a specific virtual datacenter, select the virtual datacenter.
To select icon or grid view, click the icon symbol or the grid symbol in the top right hand corner.
To jump directly to the virtual appliance or virtual datacenter of the VM, go to Grid view and use the shortcut links by clicking on the name fields.
To filter the VMs, enter text from the VM details with wildcards as required. See Search and filter VMs
To move a VM to another VApp in the same virtual datacenter:
Select the VM
On the VM control panel, click the VM move button
Select the virtual appliance or create a new one, and click Accept
If you have the privilege to restrict VMs, you may also be able to move the VM to a restricted VApp in the same virtual datacenter.
To restrict a VM by moving it to a restricted VApp:
Click the VM move button on the VM control panel
Select the option to move the VM to a restricted VApp OR select a restricted VApp from the list, or create a new one
To delete a VM, move the mouse over the VM and from the VM options menu, select Delete.
If the virtual appliance or VM is deployed, you do not need to undeploy it. You can directly delete a VM that is deployed.
To view the networks available to a virtual datacenter, go to Virtual datacenters → select virtual datacenter → Network.
In the Networks list, to view the pool and allocation of IPs:
You can then:
Private networks are only available within a virtual datacenter. However, your cloud provider may configure an external gateway for your virtual datacenter.
To create a private network in your virtual datacenter, click thebutton and complete the form below.
Name of the network (VLAN). The name can contain up to 128 characters
|IPv6||Select checkbox for IPv6 network|
|Netmask||Network mask with an integer value of between 16 and 30|
Private address range of the network
Gateway of the VLAN. Must be an IP within the range of the network address and mask
The primary DNS
The secondary DNS
The DNS suffix
|Excluded from firewall||Select Excluded from firewall to define a network where VM firewalls will not apply|
Select Define to create static routes. See Configure Static Routes
Make this network the default network, replacing the existing default network.
You can configure static routes when you create or edit a VLAN. However, you should check with your systems administrator about when changes to static routes may be received by your VM.
Destination network mask
Destination network or host
Next hop (on your network)
Name of the VLAN. The name can contain up to 128 characters
|IPv6||Select checkbox for IPv6 network|
|Strict||IPv6 only. If you select Strict, Abiquo will automatically generate the network address (ULA) and also the IP addresses. If you do not select strict, you can enter the network address and IP addresses.|
|Netmask||Network mask of 48, 56 or 64.|
Private address range of the network. Only for non-strict networks
The primary DNS
The secondary DNS
The DNS suffix
Make this network the default network. In a datacenter, this will override the existing default network
When you onboard from public cloud, if the provider supports networks, then the platform will onboard private networks, including details of IP addresses not used by VMs. You can synchronize these networks.
When working in Abiquo, DO NOT DELETE networks directly in the provider because this may cause inconsistency. The synchronization process is designed to onboard public cloud elements, especially when you begin to work with a public cloud provider
When creating a custom private network in AWS, you can choose the Availability Zone. Availability Zones enable users to deploy VMs separately, with high availability. You can deploy in an availability zone by assigning a private IP address in the network belonging to that Availability Zone.
To create new IP addresses in your private network, click the Add button in the top right-hand corner of the Private IPs page. You can also create IPs automatically, directly in the Edit VM popup.
When you add IPv6 addresses on strict networks, you don't need to set the starting address.
On non-strict IPv6 networks, Abiquo recommends that you create an automatic IP address, or you can enter an IP address manually as shown here.
The platform will delete only the IP addresses that are not in use, which means not attached to a VM, or not purchased by the enterprise.
To delete IP addresses:
To edit a private network
The new settings will apply to all VMs deployed after you save the network.
You can delete a private VLAN if no VMs are using its IPs and it is not the default network. To delete a private VLAN, select it and click the Delete button above the Networks list.
The platform automatically onboards external networks when you onboard virtual datacenters from vCloud Director.
To manage External networks, go to Virtual datacenters → Network → Select vCloud VDC → External.
If an onboarded network has been deleted in the provider, its name will display in light gray text.
If a VM is using an IP from this network, then you cannot deploy the VM.
If there are no VMs using the IPs of an external network that was already deleted in the provider, then you can delete the network, by clicking the Delete button.
If you deploy a VM without assigning a NIC, Abiquo will add one in the virtual datacenter's default network.
To set a new or existing network as the default:
In private cloud, if you set a public network as the default, obtain IP addresses for your VMs before you deploy!
This dashboard is the first screen you will see when you log in to Abiquo. It has Metrics, Hybrid and Optimization tabs.
The Metrics tab provides a general view of the resources currently being used by your virtual datacenters, as well events.
Last deployed VMs: the last five VMs deployed by the tenant on the platform. It can be filtered by user, including deleted users.
Last triggered alerts: the last five alerts triggered for the tenant on the platform
The Hybrid tab provides an overview of the distribution and cost of your resources between public cloud providers and private cloud.
Virtual machines count: the enterprise's VMs that are deployed in public cloud providers or private cloud. You can filter the list by public cloud provider or private cloud.
Workload of VMs by location: a graph of the enterprise's VMs deployed in public cloud providers or private cloud. The virtual machines are counted by location (public cloud region or datacenter). To view the detailed list with a count of VMs in each location, click on the graph
The Optimization tab aims to help you make best use of your cloud resources.
For more details of a VM, click on the arrow symbol beside the VM details
Highest CPU usage: the five VMs with highest average CPU usage over the last 30 days
Highest RAM usage: the five VMs with highest average RAM usage over the last 30 days
Longest time ON: the five VMs with the highest uptime on the platform in hours, calculated from the accounting data and not requiring the VMs to currently be in any specific state. You can filter by user name and deleted users
Lowest CPU usage: the five VMs with lowest average CPU usage over the last 30 days
Lowest RAM usage: the five VMs with lowest average RAM usage over the last 30 days
Unused public IPs: the public, floating, or NAT IPs that have been reserved by the tenant but are not in use on a deployed VM
Unused load balancers: the load balancers that have been created by the tenant in the provider but are not in use for deployed VMs
The Events view allows users to find out what is happening in Abiquo. To open the Events view, click on the Events icon in the main menu bar.
Event viewing can be restricted from no event privileges to events for the current enterprise only.
If the events you expected to display do not appear in Events view, check with your System Administrator.
To add new events to the list as they arrive, select the Update automatically checkbox. Otherwise, the list will refresh when you open the view.
Double-click on an event to see the event detail in the panel below the event list
The event list has the following columns:
Shows the system object that is the source of the event or error and its full hierarchy. For example, en event about deploying a VM could show the name of the virtual appliance and the virtual datacenter it belongs to.
|Severity||The severity of the event. Can be INFO, WARN or ERROR|
|Action||The action that generated the event. See Entity and Action Tables|
The user who performed the Action.
The date and time when the event was generated.
|User||The user affected by the action|
Additional information about the event that will display in the system logs.
To make it easier to find a specific event, use the filter tool. Click the filter buttonat the top right of Events view. Enter your filter criteria and click Accept. To remove the filter, click Clear at the bottom of the popup.
Basic event filtering enables you to filter with the following fields:
|Severity||Pull-down list of Severity types|
|Action||Pull-down list of Actions from Entity and Action Tables|
|Performed by||The name of the user who performed the action|
|Date from||Start date in format YYYY/MM/DD|
|Date to||End date in format YYYY/MM/DD|
Click "See more" on the basic filter panel to filter on more fields. You can search for events related to specific entities.
Events on the Abiquo platform are classified into three severity categories: info, warning and error.
General information events for the user as part of the normal use of the platform
Warning about an abnormal situation that does not block normal use of the platform
Error that blocks the normal use of the platform
These values can be used to filter the events by Component.
These values can be used to filter the Events list by Storage System:
The entity and action tables show events that will be displayed for Cloud Users, with a basic cloud user role and privileges.
See Events View for Cloud Users for a full list of events.