Infrastructure and tenant provisioning guide
A guide for cloud administrators to provision infrastructure and tenants.
Flow chart
This flow chart describes the basic process for provisioning infrastructure and tenants.
Create datacenters and public cloud regions
This section describes all the basics for adding your datacenter infrastructure and public cloud providers to the platform.
Abiquo defines a datacenter as a set of IT resources (servers, networking and external storage) in the same physical location. From the Infrastructure view you can manage basic infrastructure elements such as networks, racks, and physical machines.
Abiquo defines a public cloud region as a set of IT resources exposed by a supported cloud provider.
The following diagram shows a datacenter with compute resources and a public cloud region in AWS with VPCs.
Create a datacenter
Before you begin:
Obtain the IP address of the Remote Services server. If you are using a monolithic trial environment, this is the same as your Abiquo Server IP address
Check if you will require the DHCP service (it is required for standard Abiquo networking) and check the protocol to use (Omapi or Dnsmasq). See also Configure DHCP remote service with dnsmasq
Privilege: Access infrastructure view and Private DCs, Manage datacenter
To create a datacenter do these steps:
- Go to Infrastructure → Private
- At the bottom of the Datacenters list, click the + add button
- On the Create datacenter dialog, enter the Name of the datacenter and its Location to plot the datacenter on the Infrastructure view map. Then click Next
- To create the datacenter remote services, enter the IP address of the remote services server for the Virtualization manager. To copy the remote service location, click Duplicate IP addresses
After the platform creates the datacenter, do these steps:
- To allow users to deploy in the datacenter, edit your enterprises to add the new datacenter to the Allowed datacenters list
- To allow administrators to manage the datacenter, edit your administration scopes and add the new datacenter
Related pages
- UI reference for creating remote services for a datacenter: GUI Create datacenter Remote services
- Troubleshoot when you create a datacenter
Create a public cloud region
A public cloud region represents a region of a cloud provider in Abiquo, to enable users to use virtual resources and deploy VMs in the cloud.
Privilege: Access Infrastructure view and PCRs, Manage public cloud regions
Before you begin:
- To create a public cloud region for a vCloud Director cloud, obtain credentials for the Administrator or Organization. For more details, see VMware vCloud Director integration.
To create a new public cloud region:
- Go to Infrastructure → Public
Click the + add button at the bottom of the public cloud regions list.
The Create public cloud region dialog will open. Enter the base Name and select the Provider. Select the Regions
The platform will create the first region with the Name you enter and the others with a suffix of "_1", "_2", and so on.
If for some reason the platform cannot create a region, it will move on to the next region on the list
Click Next
- In the remote services IP address field for the Virtualization manager, enter the first letters of the domain name of the remote services server and select it from the selection list
- Click Save
The platform will create your public cloud region.
- To allow users to deploy in the public cloud region, edit your enterprises to add the new region to the Allowed datacenters list and to add cloud provider API credentials See Obtain public cloud credentials
- You will require one separate account for each enterprise using a public cloud region, i.e. one account per enterprise
- For certain regions, such as those in China, you will require separate credentials, which you can enter separately with the appropriate provider (e.g. Amazon CHINA)
- For vCloud Director, you will require Organization and Administrator credentials
- To allow administrators to manage the public cloud region, edit your administration scopes and add the new region
Create datastore service levels
In private cloud, to group hypervisor datastores and price them according to service levels, use datastore tiers.
- When you use tiers, administrators or cloud users can choose the service level for VM hard disks at the level of VM templates, virtual datacenters, and VMs.
- When you perform VM or storage moves outside of Abiquo, the platform will synchronize disks to their new datastore tiers.
- If you do not enable datastore tiers feature, all datastore disks will be created in the "Default Tier".
You can add datastores to a tier when you add a hypervisor to the platform, or from the Datastore tiers tab.
- You can only add datastores to datastore tiers if they do not have any managed VM disks on them or if none of the disks are in a tier.
To restrict the use of datastore tiers, you can make them:
- Not allowed: an enterprise cannot use a tier that is not allowed, and they cannot create disks in this tier.
- Disabled: the administrator can disable a tier, for example, for maintenance, migration, or administrative reasons.
In widgets on the Dashboard, the platform will display tiers that are allowed, and tiers that are disabled.
Create datastore tiers
To create a datastore tier:
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage storage elements
- Go to Infrastructure → Private → select datacenter → Datastore tiers
- Click the + Add button
- Enter the Name and Description
- Optionally select an Abstract datastore tier to add the tier to a group to control storage service levels for tenants in more than one datacenter. See Abstract datastore tiers for storage service levels
- Click Save
The platform will create the tier and allow access to all future enterprises that you create.
Configure networks
Before you configure your private cloud networks in Abiquo, configure the network infrastructure outside of the platform. You will need ranges of VLAN tags and IP addresses for use in the platform. See Network in the Abiquo Infrastructure Guide.
To manage datacenter networks:
- Go to Infrastructure → Private → select a Datacenter→ select datacenter details view → Network
To manage networks in public cloud:
- Go to Cloud view → select a virtual datacenter or All virtual datacenters → Network
Create labels for networks and hypervisor NICs
To assign networks to network interfaces on your hypervisors, tag the network interfaces with "network service types". Then later, tag your networks to assign them to these network interfaces.
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage network elements
To create network service types:
- Go to Infrastructure → Private → select datacenter → Servers section → Network → Network service types
- Click the + add button
- Enter the Name of the network service type that the tag will represent
- Click Save
Define network virtualization integrations with devices
The platform has integrations with network virtualization systems to offer features such as network blueprints, self-service firewall and load balancer policies, NAT, and VPNs. The platform uses Devices to define integrations with external systems.
Devices do the following:
- register the endpoint and credentials of the network virtualization system in a private cloud datacenter
- contain a list of the virtual datacenters that the network virtualization system is managing.
A device can be created:
- For a datacenter
- For a single enterprise
A device belonging to a specific enterprise has a higher priority than a device for all enterprises.
The device functionality is transparent to the cloud user, who will automatically have self-service access to networks, and firewall and load balancer policies.
Privilege: Manage devices
To create a device to define a network virtualization system:
- Go to Infrastructure → Private → select Datacenter → Datacenter details view → Network → Devices
- Click the + add button and enter the device details
For more details see GUI Create device SDN
To use a network virtualization system to manage Abiquo external and public networks, the Network Administrator must first pre-create the networks in the network virtualization systems.
Then when you create the external or public network in Abiquo, select the device for your virtualization system.
Reserve private network ranges with excluded networks
To create an excluded network:
- Go to Infrastructure → Private → select a datacenter → Servers view → Network → Excluded
- Click the + Add button and enter the network details
For more details see GUI Add a network to exclude - Click Save.
- If users already have private networks with this range, the platform will display a warning popup. To force the creation of the excluded range, click Confirm.
The platform will exclude the network range. Users with existing private networks within the excluded range can continue to work with them. But if the users delete the networks, they will not be able to create them again.
You can also manage excluded networks with the API.
API Documentation
For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource ExcludedNetworksResource.
Configure NAT
As part of the Abiquo NSX integration, you can use the NAT blueprint to configure virtual datacenters with NAT.
- To configure the NSX integration, see Configure the NSX integration.
To configure NAT for a datacenter:
- Go to Infrastructure → Private → select datacenter → Network → Devices
To define the NSX integration in Abiquo, create a NAT device
Create racks
Before you add a Physical Machine to a Datacenter, you need to create the Rack it will belong to.
A rack is a logical set of Physical Machines providing the same level of compute service.
Each rack also defines a VLAN pool for all the physical machines inside the rack. This pool is used to provide Private networks to Virtual Datacenters.
To create a rack:
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage datacenter infrastructure elements
- Go to Infrastructure → Private → select a datacenter
- At the bottom of the Physical servers list, click the + add button and select Rack
- Enter the Name and optional values
- Go to Network
- For Network ID min and Network ID max, enter the range of the VLAN or VXLAN tags to use on this rack for private networks
- In Excluded VLAN IDs, enter a comma-separated list of ranges (with a dash "-") and/or individual tags that you will use for other networks.
- In Reserved VLANs per VDC enter the number of VLANs that you expect VDCs to use. Note that this is not a real reservation, but it will prevent the creation of too many VDCs on the rack!
- In VLAN pool size enter the number of VLANs to reserve for VDCs that use more than the expected number
- Click Save
Related pages:
Create servers
To add a host (also called a server or physical machine)
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage datacenter infrastructure elements
- Go to Infrastructure → Private → select datacenter → Servers
- If there are no racks, first create a rack. See Create racks
- Select a rack, then click the + add button. Select Physical machine
- Select the Hypervisor type, which could be a standard hypervisor, master hypervisor such as vCenter, or VMware vCenter cluster as a physical machine
- Remember when you are configuring test environments that you cannot add a vCenter more than once, for example, as a master hypervisor and as a cluster!
- Enter the connection details. You can enter the IP address or the FQDN of the server
Using the connection details, the Discovery Manager remote services will try to retrieve the hypervisors or clusters from a master hypervisor or connect with the hypervisor or cluster. - For a master hypervisor, the multiple hypervisor selection dialog will open with a list of the physical machines managed by the master hypervisor. Select the ones that you wish to add and click Edit to complete their details as required.
- After the platform retrieves each host (server or "physical machine"), the Create physical machine dialog will open.
Register a physical machine in Abiquo
To register a physical machine in Abiquo, do these steps.
- Enter the Name, which defaults to its IP address, and check the other details
- Go to Network interfaces and enable at least one network interface. To do this, select the network service type of the VLANs that will use this interface
- Go to Datastores and and enable at least one datastore.
For vCenter clusters, use shared datastores, and if you require local datastores, add them to single-host tiers
- When you use a shared datastore, the platform creates a different datastore on each physical machine using the datastore. This means that a shared datastore can be enabled on one host and disabled on another, either as a result of user configuration or an issue (e.g. an NFS communication error on one host).
- Do not enable the NFS repository (usually /opt/vm_repository) because this will severely degrade deployment performance
- Click Save
Related pages:
- UI Reference:
- GUI Create physical machine General information
- GUI Create physical machine Network interfaces
- GUI Create physical machine IPMI. Deprecated
- GUI Create physical machine Datastores
Create allocation rules
The platform uses allocation rules to control the scheduling of resources in datacenters, although your virtualization technology must manage the use of the resources. For details of the allocation process, see the Virtual Machine Allocation section.
There are two types of allocation rules: Global rules apply to all datacenters and Datacenter rules apply to the selected datacenter.
Create a global load balance rule
The platform uses allocation rules to control the scheduling of resources in datacenters, although your virtualization technology must manage the use of the resources. For details of the allocation process, see the Virtual Machine Allocation section.
You can create the following types of load balance rules:
- PERFORMANCE: select the machine with the most available resources. If more than one physical machine has the same resources available, use a round-robin algorithm to allocate each VM to a different physical machine.
- PROGRESSIVE: select the same physical machine until it is full, then change to another one. Begin with the machine with the most available resources. Default rule
To create a global load balance rule:
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage allocation rules
- Go to Infrastructure → Private → select a datacenter
- If you are in Map view or Statistics view, click the Server symbol in top right-hand corner to go to Servers view
- Go to Allocation rules
- On the Global panel, click the + add button
- As the Rule type select "Load balance"
Select the Load balance type
Create datacenter load balance rules
The platform uses allocation rules to control the scheduling of resources in datacenters, although your virtualization technology must manage the use of the resources. For details of the allocation process, see the Virtual Machine Allocation section.
You can create the following types of load balance rules:
- PERFORMANCE: select the machine with the most available resources. If more than one physical machine has the same resources available, use a round-robin algorithm to allocate each VM to a different physical machine.
- PROGRESSIVE: select the same physical machine until it is full, then change to another one. Begin with the machine with the most available resources. Default rule
A datacenter load balance rule will have priority over a global load balance rule.
To create a datacenter load balance rule:
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage allocation rules
- Go to Infrastructure → Private → select datacenter
- If you are in Map view or Statistics view, click the server symbol in top right-hand corner to go to Servers view
- Go to Allocation rules
- On the Datacenter panel, click the + add button
- Select Load balance as the rule type
- Select the load balance type
Create load level compute rules
To specify the CPU and RAM load on machines, use compute load level rules. The scheduler will use these rules to help determine if a physical machine is a candidate to hold a VM.
The platform uses Load level rules to specify the level that the scheduler can assign to the virtualization technology. The virtualization technology is responsible for managing the load that is assigned
You can create load level rules for the following elements:
- a datacenter (all racks)
- a rack (all servers on the selected rack)
- a cluster (for supported hypervisors)
- a specific server
You can only add one rule for an element at each level, but more than one rule may apply.
The priority order of rules is any cluster rule first (if it is present), then the other rules from the most specific rule to the least specific rule. A cluster rule affects all hosts in a cluster irrespective of their state, for example, it applies to hosts that are powered off.
To create a load level compute rule:
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage allocation rules
- Go to Infrastructure → Private → select a datacenter
- If you are in Map view or Statistics view, click the Server symbol in top right-hand corner to go to Servers view
- Go to Allocation rules
- On the Global panel, click the Add button
- Select the "Load level compute" rule type
Complete the dialog
For more details see GUI Add a new rule load level compute
Create load level storage rules
To specify the storage load on machine datastores, use storage load level rules. The scheduler will use these rules to help determine if a physical machine is a candidate to hold a VM.
You can create rules for the following elements:
- A datacenter (all datastore tiers)
- A tier (all datastores in a tier)
- A specific datastore.
If there is more than one rule that applies to a datastore, the most specific rule takes precedence over more general rules.
To create a load level storage rule:
Privilege: Access infrastructure view and Private DCs, View datacenter details, Manage allocation rules
- Go to Infrastructure → Private → select a datacenter
- If you are in Map view or Statistics view, click the Server symbol in top right-hand corner to go to Servers view
- Go to Allocation rules
- On the Global panel, click the Add button
- Select the "Load level storage" rule type
Complete the dialog
For more details see GUI Add a new rule load level storage
- The platform uses Load level rules to specify the level that the scheduler can assign to the virtualization technology. The virtualization technology is responsible for managing the load that is assigned
Create hardware profiles
Hardware profiles are a convenient way of displaying CPU and RAM values that enable you to simplify the configuration of VMs for your users. They also enable you to control available hardware configurations and to recommend suitable hardware configurations for VM templates. And you can restrict users to a set of recommended configurations for a template. Abiquo has a default set of hardware profile families for public and private cloud.
- In public cloud, you can synchronize the provider's profiles in the platform
- In private cloud and public clouds without native hardware profiles, you can create and fully manage hardware profiles and their types in the platform
- Some cloud providers may support both hardware profiles, and CPU and RAM, for example, vCloud Director
In private cloud, Abiquo supports dynamic hardware profiles for CPU and RAM, so the user can enter these values and the platform uses CPU and RAM prices for them. And the user can enter cores per socket.
In public cloud, you can onboard and synchronize price lists of hardware profiles and incorporate them into your pricing models. Note that the Azure API returns a value for cores per socket but the platform does not use this value.
Manage hardware profiles with the API
API Documentation
For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource HardwareProfilesDatacenterResource.
Synchronize hardware profiles for a public cloud region
In public cloud providers with hardware profiles, when you create a public cloud region and add credentials for an enterprise, Abiquo will automatically retrieve the hardware profiles for the public cloud region.
- Provider hardware profiles are locked and you cannot edit them
- In public cloud regions with provider hardware profiles that also support CPU and RAM, you can deactivate hardware profiles mode
- The platform also registers if a hardware profile is Active and if it belongs to the Current generation
To synchronize hardware profiles:
Privilege: Access infrastructure view and PCRs, View public cloud region details, Manage enterprises
- Go to Infrastructure → Public → select Public cloud region → Servers view → Hardware profiles
- At the top right of the Hardware profiles pane, select an enterprise with a public cloud account
- Click the round arrows refresh button
By default, for each enterprise with credentials, the hardware profiles mode is enabled. By default, all hardware profiles are available to all enterprises.
Classify hardware profiles in private cloud
To help users to easily select the right hardware profile for their VMs, providers usually classify hardware profiles by family and type.
The platform contains one set of default families that are available in both public and private cloud.
In private cloud and in public cloud regions without native hardware profiles, you can also create your own hardware profile families and types that will be available in all of these locations.
To classify hardware profiles, first create families, then create types.
To create a hardware profile family or type:
- Go to Infrastructure → Private → select a datacenter → Hardware profiles
OR Go to Infrastructure → Public → select a region without native hardware profiles → Hardware profiles - At the bottom of the Types list, click the + Add button and select Family or Type
- Complete the dialog as shown below and click Save
Create a hardware profile family
For more details see GUI Create hardware profile family
Create a hardware profile type
For more details see GUI Create hardware profile type
Create a hardware profile
You can create Abiquo hardware profiles in private cloud datacenters and for public cloud providers that do not have provider hardware profiles, such as vCloud Director clouds.
Privilege: Access infrastructure view and private DCs, View datacenter details, Manage datacenter infrastructure elements
To create a hardware profile:
- Go to Infrastructure → Private or Public → select a location → Hardware profiles
- Click the + add button
- Enter the details of the hardware profile
- Click Save
Field | Value |
---|---|
Active | Select this checkbox to activate or deactivate the hardware profile Troubleshooting
|
For more details see GUI Create hardware profile
Set prices for hardware profiles
You can set prices for hardware profiles using cost codes or for each individual hardware profile.
- For dynamic hardware profiles, the platform will also use the prices for CPU and RAM.
- For details of how to create cost codes pricing, see Pricing View#Manage cost codes to create the cost codes. Then see Pricing View#Create a new pricing model, to set cost code prices.
- For details of how to set prices for individual hardware profiles, see Pricing View#Create a new pricing model, to set hardware profile prices for each datacenter or public cloud region.
Provision tenants
This section describes how to set up enterprises, which are basic cloud tenants.
Before you create tenants, you should do these steps:
- Add infrastructure to the platform in Infrastructure View.
- Configure the platform in Configuration View including: Configure two factor authentication
- Prepare enterprise themes for white-labelling following the Abiquo Branding Guide
- Create roles and scopes
- Create pricing models
Introduction to user roles
Each user has a role to define how they can work with resources.
User roles have groups of privileges to allow access to different cloud features.
- Global roles are available to all enterprises, and display with "(Global)" after the name
- Enterprise roles belong to a specific enterprise, and the platform displays them when you select an enterprise.
OpenID, AD, or LDAP groups
You can specify directory groups in user roles. The platform will automatically create users and assign the matching roles to them.
See LDAP and Active Directory Integration and Abiquo OpenID Connect Integration.
Generally, you will assign one role to a group of users. You can clone and modify default roles to create your own roles. The Privileges page lists all the privileges and marks those assigned to each default role.
Default Role | Description |
---|---|
CLOUD_ADMIN | Manages the physical infrastructure and configurations in order to offer a cloud service. The default "admin" user has this role and unlimited global scope. You can create cloud administrators with lesser scopes that restrict them to certain enterprises and cloud locations. You cannot modify the privileges of this role. There must always be at least one user with this role and the global scope, but it does not have to be the default admin user. |
ENTERPRISE_ADMIN | Manages configurations at enterprise level and grants access to other enterprise users. You can add privileges to allow the user to administer multiple enterprises, for example, as a reseller. |
USER | Works with virtual appliances in their enterprise. |
OUTBOUND_API | The default privileges of this role allow the user to read all events. This user is for the module that stores events in the API and streams them for the outbound API. |
ENTERPRISE_VIEWER | Allows read-only access to the cloud platform. A user with this role can access a VDC and view VApps, VMs and VM details. |
Privileges are generally independent, for example, when the user role does not have the "Access Infrastructure view" privilege, the Infrastructure icon will not display in the UI. However, with the "Manage datacenters" and "View datacenter details" privileges, the user can access this functionality through the API.
For information about creating a reseller, see Create a Reseller and Reseller Administrator User
Changes to privileges by version
Create a user role
To create or clone a role do these steps:
- Go to Users → Roles.
- To clone a role, click the clone button. The platform will prefix the clone name with "Copy: ".
- To create or modify a role, click the + Add button or Edit button and complete the following dialog and click Save.
For more details see GUI Create role - Select the role and modify its privileges
Edit user role privileges
To edit the privileges of a role do these steps:
- If you wish to modify a local role, first select the enterprise that the role belongs to
- Select a role in the Roles list
- Edit the privileges, selecting or deselecting groups or individual privileges as required
- See Privileges for more details of existing roles
- Click Save or discard changes by clicking outside the privileges pane, e.g. by clicking another role.
Privilege: Access Roles and Scope screens, Manage roles, Manage global role
Manage roles with the API
API Documentation
For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource RolesResource.
Introduction to user scopes
A user scope is an access list that allows the user to access the appropriate resources in the tenant hierarchy. The platform controls access with the role, the scope, and the tenant's allowed locations. The tenant's default scope positions the tenant in an optional tenant hierarchy, and the platform assigns it to the tenant's users by default. For an administrator that can work with more than one tenant, the platform uses the Enterprises list to control access to tenants.
To manage a complex hierarchy of resellers and/or tenants and to delegate user management and share resources, create a scope hierarchy. See the following sections:
Create a scope
If you would like to restrict your tenants to a specific set of resources or allow administrators to access a limited group of tenants, then you can create a scope, which is an access list. We recommend that you create a scope before you create an enterprise. This means that you will give the scope access to the public cloud regions and datacenters first. Later you will edit the scope and add the tenant enterprise and any new enterprises that the tenant will directly manage.
Privilege: Manage scopes, Allow user to switch enterprises
To create a scope do these steps:
- Go to Users → Scopes
- Click the + add button
- Enter the Name
- Optional: to add the scope to a hierarchy, select a Parent scope
- Select Datacenters and Enterprises to include in the scope
- The options to Use all enterprises or Use all datacenters will automatically include new enterprises or datacenters
Create a scope - General info
Create a scope - Entities
Manage scopes with the API
API Documentation
For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource ScopesResource.
Create a basic enterprise
This section describes how to create a basic tenant enterprise for a cloud tenant. For more detailed information, see Manage Enterprises.
To create a basic customer enterprise do these steps:
- Go to Users
- At the bottom of the Enterprises list, click the + add button to add an enterprise
On the General tab
- Enter the customer Name
- As the Default scope, set the tenant scope
The platform will automatically add this enterprise to the scope. Note that if you change the default scope of an enteprise, the platform will not remove the enterprise from its previous scope.
- If the enterprise represents the tenant headquarters or similar, select Key node
- Go to Allocation limits and set resource usage limits for the enterprise
- A Hard limit is the maximum amount of a virtual resource (e.g. RAM) that an entity will be allowed to consume.
- A Soft limit warns users and administrators that the entity is running out of a resource.
The rules for creating allocation limits are as follows:
- You cannot have a hard limit only
- Soft limits must always be less than or equal to hard limits
- When a limit is equal to 0, it means that there is no limit to resource usage at this level
When editing limits, you cannot set the hard limits below the existing resource usage, except for Local hard disk
- On the Datacenters tab, drag and drop providers, datacenters, or regions to Allowed datacenters, to allow the tenant's users to work in them.
- To configure the tenant in each allowed location, see Configure an Enterprise in a Cloud Location
- On the Properties tab, for each tenant metadata property, enter a key and value, and click Add
To onboard all public cloud VMs into a single virtual appliance, set the singlevapp property to true. If you wish to configure the name, set the singlevapp name enterprise property:
"sync.singlevapp":"true", "sync.singlevapp.name":"sync vapp name"
- Optionally add credentials for public cloud. See Add credentials for public cloud
- Click Save
The platform will create the enterprise and filter to display only this enterprise.
To display other enterprises, click the X beside the enterprise name in the filter box at the top of the Enterprises list.
Create a pricing model
If you already have a pricing model that is assigned to your enterprise, then the platform will use this model as the basis for the new pricing model. You can then enter a percentage markup on the costs for your enterprise.
To create a pricing model:
- Go to Pricing → Pricing models
- Click + add and enter details, including resource prices, and cost code prices.
Field
Description
Name
The name of your pricing model. The name can represent a service level agreement
Description Description of pricing model Change all resource prices Only displays when the enterprise already has a pricing model assigned to it. Resellers can change all prices by adding this percentage. See below
Charging period
Standard period of time by which a user will be charged, such as day, week, etc. Does not have to be equal to the minimum period
Minimum charging period
Minimum period of time that a user will be charged for. This may be longer or shorter than the charging period. This value is not sent to the billing system. Note that the accounting system records the maximum usage value of a resource during an accounting period.
Currency
The currency for this pricing model. Enter new currencies in the Currency tab before you create the pricing model
Standing charge
Standing charge per Charging period. You can include this value in the pricing estimate message but the platform does not send it to the billing system
Minimum charge
Minimum charge per Minimum charging period. You can include this value in the pricing estimate message but the platform does not send it to the billing system
Show charges before deployment
Mark this checkbox to show a pricing estimate popup before deployment with the message entered in the box at the bottom of the window. See the explanation below
Insert variable
Choose a variable from the pull-down list to add to the pricing estimate message. The variables are described in the table below
Deployment message
Enter the estimate message for VM deployment, including variables. See Create a pricing estimate message
The platform uses the first pricing model for a location in a currency as the set of base prices for the location. When you create a new pricing model, you can enter a percentage to modify prices. If you then enter a resource price that is lower than the base price, the platform will highlight the price.
Field
Description
Hypervisor Datastores GB
Price of hypervisor datastores per gigabyte. In public cloud regions, the platform does not use this value
VLANs
Price per VLAN (at least one VLAN is always created for each virtual datacenter)
Public IPs
Price per public IP address reserved
CPU
Price per virtual CPU core for deployed virtual machines. If the location uses hardware profiles, pricing does not use this value.
CPU on
CPU offPrice per virtual CPU core when virtual machine is powered ON or OFF Memory (GB)
Price of virtual memory in GB for deployed virtual machine. If the location uses hardware profiles, pricing does not use this value.
Memory on
Memory off (GB)Price of virtual memory in GB when virtual machine is powered ON or OFF Virtual machine Fee per VM in addition to charges for other VM items Virtual machine on
Virtual machine offFee per VM in addition to charges for other VM items Repository (GB) Price of template repository use in GB for virtual machine templates. The platform does not include conversions. In public cloud regions, the platform does not use this value Anti-Affinity Price per VM deployed in anti-affinity layer. In public cloud regions, the platform does not use this value Firewall Price per firewall attached to VM Load balancer Price per load balancer attached to VM DR protected VM Price per VM protected with disaster recovery The provider can configure billing by usage or allocation.
Datastore tiers
In a private cloud datacenter, datastore tiers set service levels for storage. See Manage Datastore Service Levels with Datastore Tiers.
Persistent storage
In a private cloud datacenter, persistent storage tiers set service levels for storage. See Manage Storage
Hardware profiles
In public cloud and in private cloud datacenters with hardware profiles, see Hardware profiles.
Privilege: View datacenter details, Manage enterprises
Cost Code Prices
The cost codes for assigning to templates and hardware profiles, and their prices.
Assign a pricing model to the enterprise
To assign a pricing model to the enterprise, do these steps:
- Go to Users → Edit enterprise
- Go to Pricing
- Select the Pricing model from the list
You can also assign pricing models at Pricing → Pricing models → Enterprise associations.
Create a tenant administrator user
To create a tenant administrator user:
- Go to Users → Optionally, select an enterprise → Users tab
- Click the + add button to add a user and complete the dialog
- Role: select ENTERPRISE_ADMIN or similar
- Scope: select a scope that contains the enterprise/s that the administrator will manage, for example, to manage users
- Click Save
For more details see GUI Create user General information
For more details see GUI Create user Advanced
Provision networks
This section describes how to manage datacenter networks in Abiquo. It explains the basic datacenter network concepts and links to datacenter network pages.
Privilege: Manage datacenter infrastructure elements, Manage datacenter infrastructure elements, Manage network elements, Manage devices
Cloud networks are the virtual networks that administrators configure to deliver self-service IP addresses to the VMs.
The cloud network types supported by Abiquo are as follows:
- Private Networks within virtual datacenters (in private and public cloud)
- External Networks accessible from outside the virtual datacenter and outside the platform, and assigned to a single tenant. Used in private cloud with standard networking and integrations.
- Unmanaged Networks with IP addresses managed outside of Abiquo only, and assigned to a single tenant. Used in private cloud
- Public Networks with public IP addresses and Internet access and can be shared by multiple tenants. Used in private cloud
- Public IPs in public cloud, such as AWS Elastic IPs.
The external, unmanaged, and public networks may be collectively referred to as 'datacenter networks' because they are managed at the Abiquo datacenter level.
Create public networks
Public Networks allow the users of virtual datacenters to use Internet addressable public IP addresses in their virtual infrastructure. Users purchase or reserve public IPs for their enterprises in Virtual datacenters view.
To create a public network:
- Go to Infrastructure → Private → select Datacenter → Datacenter details → Network → Public
- Complete the dialog
v50_inf_pri_net_pub-Create_network-Public-IPv6.png
Field | Value |
---|---|
Name | The name of the public VLAN with up to 128 characters |
IPv6 | To create an IPv6 network, select this checkbox |
Strict | For IPv6 networks only. If you select Strict, the platform will automatically generate EUI64 IP addresses. |
Address | The network address of the VLAN |
Netmask | The network mask in CIDR format. For IPv4, the value can be from 16 to 30 inclusive, and for IPv6, enter a value of 64, 56, or 48 |
Gateway | The gateway of the network that must be within the range defined by the network address and the network mask |
Tag* | Enter the VLAN or VXLAN tag to use for this network |
Check | Click to check tag availability for all the racks of the Abiquo datacenter.
|
Network service type | Choose the Network Service Type, which assigns the network to network interfaces on the hypervisors |
Device | Optional device that defines a network virtualization system that will manage the IP addresses of this network. They may be assigned using its DHCP service. Ensure that VMs deployed on this network allow traffic to the appropriate ports for a DHCP connection. |
Primary DNS | Address of the primary DNS |
Secondary DNS | Address of the secondary DNS |
DNS suffix | The default DNS suffix |
Restricted | Select to create a Restricted network so that users require privileges to Attach NICs in restricted networks and/or Detach NICs from restricted networks |
Excluded from firewall | Select Excluded from firewall to define a network where VM firewalls will not apply |
Static Routes | Click "Manage" to add and modify static routes. |
Provider ID | For NSX-T public networks, enter the path to the Tier 0 segment in the NSX-T system. |
For NSX-T, you can register a network that your network administrator created in NSX-T.
- Abiquo will reserve the first 20 addresses of this network for load balancers
- You cannot use a reserved address for a DHCP server
After you select the Device (nsxt-device), enter the Provider ID and select the Network service type.
Create an external network
External networks belong to a single enterprise and may have public or private IP address ranges used in more than one virtual datacenter.
An external network in the platform represents a network that exists in the infrastructure, so you will need the network details:
- network address
- gateway
VLAN or VXLAN tag.
For vCloud Director, you can manage external networks in the Virtual datacenters view. See VMware vCloud Director integration
To create an external network:
- Go to Infrastructure → Private → select Datacenter → Servers view → Network → External
Click the + add button and enter the details
For more details see GUI Create network External
Create static routes for external and public networks
To add a Static Route when you create or edit an IPv4 network:
- Select the Define checkbox.
- Enter the details of the static route.
For example, to add a static route to the network/netmask 1.1.1.0/24 via the gateway/next hop 192.168.0.250
For more details see GUI Create network Static routes - Click Save and the platform will add the static routes to the VM network configuration.
- The platform will configure the static routes in VMs using the network configuration method so it may not always be possible to update the static routes in a deployed VM.
- If you are using DHCP to configure VMs, changes to static routes will be received by the VMs when they reconnect to the DHCP server; for example, after they are restarted.
Add IP addresses to external and public networks
To add IP addresses to your network:
- Go to Infrastructure → Private → select Datacenter → Servers view → Network → External or Public
- Click the + Add button in the top right-hand corner
- Complete the dialog
For more details see GUI Create IP addresses
Make IP addresses available
After you create public, external, or NAT IP addresses, they will be available to users for their virtual datacenters.
We recommend that you should make unavailable any IP addresses that will be used for administration purposes, for example, the IPv4 gateway network address.
To edit the available IP addresses:
- Go Infrastructure → Private → select datacenter → Servers view → Network → select network type
- Click Available IPs
- The Edit network dialog for Available IPs will open and by default, all IPs are in the Available column
- To move an IP, select it and click a single arrow button
- To move all IPs in the direction of the arrows, use the double arrow buttons
- Public or NAT IPs that users have purchased or reserved do not display in the Available list and you cannot make these IPs unavailable.
Create unmanaged networks
In private cloud datacenters, unmanaged networks are a special type of external network with IP addresses that are allocated outside of the platform. Abiquo does not manage the IP addresses for VMs attached to these networks.
Before you begin, obtain the details of your network in the infrastructure, including the VLAN tag, network address, and gateway.
To create unmanaged networks do these steps:
- Go to Infrastructure → Private → select Datacenter → Datacenter details → Network → External.
- At the top of the External page, click the Add + button
- Complete the dialog as described, marking the Unmanaged checkbox.
For more details see GUI Create network Unmanaged
To display IP addresses of NICS in unmanaged networks, add them:
- using the API; or
- during VM capture using the UI or API
For strict IPv6 networks, you cannot add IP addresses, but the platform retrieves the MAC address from the hypervisor and uses that to generate an IPv6 address for display, which should be the same as the one allocated by the router system.
Create a NAT network
To use NAT in private cloud, first configure the NSX integration, then define the NAT device. NAT networks are very similar to public networks.
To use NAT in vCloud Director, you will need the definition of a NAT network that is compatible with an Edge interface network, which connects the Edge to the external networks.
To create a NAT network:
- Go to Infrastructure → Private or Public → select datacenter or region → Servers view → Network → NAT
Click the + add button
Create networks with ranges of public IPs for NAT
For more details see GUI Create NAT network
To add IP addresses to your network, click the + add button in the top right-hand corner of the Networks page.
For more details see GUI Create IP addresses
The NAT network and IPs will display on the NAT tab. In the same way as for public IPs, you can quarantine NAT IPs as required.
Screenshot: NAT networks and IPs in private cloud with NSX
When users create virtual datacenters, the platform can automatically configure a NAT IP, and users can manage NAT rules, and purchase additional NAT IPs. See Manage NAT for virtual datacenters
API Documentation
For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource NatNetworksResource.
Display networks
You can scroll through the network list using the page number and arrow buttons at the bottom of the list. And you can filter the list by entering text and wildcards to search for in network names.
On the IPs page, click on the header of a column to sort by that column, use the Search box to filter the results by any field, and navigate through the pages with the page scroll.
Make a network the default for an enterprise or virtual datacenter
You can make an external network the default for an enterprise in a datacenter (see Configure a location for an enterprise) or a virtual datacenter (See Manage Networks).
You can make a public or external network the default for a virtual datacenter (See Manage Networks)
Create virtual datacenters
The platform administrator will generally create virtual datacenters for tenants when accounting is by virtual datacenter.
Before you begin:
- In Azure, before you create a virtual datacenter, Create a resource group and optionally Create an availability set.
To create a new virtual datacenter:
- Go to myCloud Virtual datacenters view
- Above the V. datacenters list, click the + add button
- Select Create a new virtual datacenter from the pull-down menu
- Complete the dialog as described below
- Click Save
General information
This section describes the basic details to enter when creating a virtual datacenter. The following sections describe further configuration.
For more details see GUI Create virtual datacenter General information
Create a virtual datacenter with custom networks
When you create a virtual datacenter, the platform always creates a private network and it counts as part of your VLAN allocation limits, even if the default network is another type of network.
The private network can be the "Automatically-created private VLAN", which is called "default_private_network", or a custom private network, which will be set as the default network.
To create a Custom private network, complete the Network section of this dialog.
To manage the VLANs or other networks of your virtual datacenter, go to Virtual datacenters → Network. See Manage Networks.
- For information about changing the default network of the VDC, see Manage Networks
Manage resource allocation limits for a virtual datacenter
- A Hard limit is the maximum amount of a virtual resource (e.g. RAM) that an entity will be allowed to consume.
- A Soft limit warns users and administrators that the entity is running out of a resource.
The rules for creating allocation limits are as follows:
- You cannot have a hard limit only
- Soft limits must always be less than or equal to hard limits
- When a limit is equal to 0, it means that there is no limit to resource usage at this level
When editing limits, you cannot set the hard limits below the existing resource usage, except for Local hard disk
For more details see GUI Create virtual datacenter Allocation limits
Set virtual datacenter defaults
When you create a virtual datacenter, you can set some defaults according to your platform configuration.
For more details see GUI Create virtual datacenter Defaults
After you create the virtual datacenter, you can edit it the default values.
Limit user access to the virtual datacenter
If you are able to manage user roles, you can limit user access to the virtual datacenter for users that are subject to VDC restriction, for example, to give users read-only access.
Privilege: Manage roles, No VDC restriction
For more details see GUI Create virtual datacenter Roles
After you have entered Allocation limits, Defaults, and Role, click Save.
The platform will create the virtual datacenter and the default private VLAN and display it in the Virtual datacenters view.
Create a virtual datacenter using the API
API Documentation
For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource VirtualDatacentersResource.
You can automate the process of creating virtual datacenters using the Abiquo API. See How to create virtual datacenters and VMs via API
Import and capture VMs
You can import and capture VMs from private cloud manually and you can also automate the process of capturing VMs using the Abiquo API. See How to capture a remote virtual machine from a managed hypervisor
Introduction to import and capture VMs
In a private cloud datacenter, when you a hypervisor or cluster to Abiquo, it may already have VMs running on it, and you can import (retrieve) and capture these VMs.
Privilege: Manage infrastructure elements
When you import (also called "retrieve") VMs, they are registered in Abiquo but not managed by Abiquo. The platform will take into account the resources they use when scheduling and allocating resources, and track their state as part of the virtual infrastructure check. The platform will also include them to improve the accuracy of resource usage statistics.
You can then capture (also called "onboard") imported VMs so they will be managed by the platform. When you capture a VM it is almost identical to a VM created in Abiquo. The main difference is that when you capture a VM, Abiquo does not have a copy of the template disks in the Apps library. This means that you cannot automatically create a fresh copy of the VM with the same configuration and the template disks, by undeploying the VM and deploying it again to copy the template from the Apps library. When you capture a VM, to store the disks in the Apps library, you can create an Abiquo instance template, which you can then use to create a fresh copy of the VM.
Importing, capturing, releasing and removing VMs from the platform does not change them in the infrastructure; these operations only determine which operations the platform can perform on them.
This diagram shows steps to import and capture VMs that were created outside of Abiquo.
Import and capture of individual VMs is only available in private cloud. To capture resources from public cloud regions, onboard them as part of regions or virtual datacenters. See Manage Virtual Datacenters#Onboardfrompubliccloud
What does Abiquo import?
To import VMs (also called retrieve VMs), the physical machine must be in an Abiquo private cloud datacenter, or in the process of being added to one. You do not need to enable a datastore to import VMs that are running on the datastore.
- You can import VMs with disks that are located on external volumes with the configuration described below
What does Abiquo capture?
Abiquo captures the following VM configuration:
- CPU and RAM including hardware profiles
- Remote access configuration for VNC, including the password. But if there is no password, the platform disables remote access
- If a user later releases a VM, the changes made in the platform will remain in the VM
- MAC addresses of compatible NICs and their VLAN tags and network details. Abiquo recommends that your VMs should have at least one NIC
- Exception: Abiquo does not capture NICs on IPv6 networks
- You can configure Abiquo to capture the DHCP configuration, see Abiquo Configuration Properties#capturedhcp
- Hard disks in compatible formats on the hypervisor datastores. See Template Compatibility Table
- For ESXI, the platform will capture DVDs without a defined position in the boot order as ISO disks in the last position in the VM's boot sequence
When you capture a VM from NSX-T, you must add the VM to a VDC with the same network as the VM network. The platform will match the network by provider ID, not by VLAN tag as in the NSX-V integration.
During capture the platform will skip incompatible VMs and incompatible virtual hardware components.
- The platform does not add the virtual datacenter's default firewall policy to a VM as part of the capture process
- You can capture VMs with disks that are located on external storage volumes with the configuration described below
- The platform does not capture VMs with external storage volumes in position 0 in the disk sequence. The boot disk must always be a "hard disk" on the hypervisor datastore
Undeploy Destroys the Captured Virtual Machine on the Hypervisor
When you undeploy a captured VM, this will destroy the VM on the hypervisor. If you would like to be able to redeploy it, before you undeploy, create an instance to copy the VM disks as a template in the Apps library. You can then create a new VM from the instance template
Configure Abiquo to Import and Capture VMs with Volumes
- For ESXi, to import VMs with disks that are located on external volumes, set the "abiquo.experimental.capturewithvolumes.bypass" property on the Abiquo Server
- For ESXi, to capture VMs with volumes (except in position 0 in the disk sequence), set the "abiquo.experimental.capturewithvolumes.bypass" property on the Abiquo Server
- The platform can capture the VMs but it does not register the external storage volumes as VM resources
- After you capture the VMs, you can add the volumes to the platform as Generic iSCSI volumes
- If you do not add the volumes as Generic iSCSI volumes and you wish to add more external volumes, in order to prevent issues with the unregistered volumes, add volumes to a new SCSI controller of a different type
Prepare to capture VMs
Before you capture a VM
- Obtain the details of the networks that the VM belongs to (VLAN tag, network address, netmask), and the IP address(es) of the VM
Identify or create these networks and IPs in Abiquo, unless the VM is only in a default private network that Abiquo will manage
- You will need to add the captured VM to a virtual datacenter (VDC), so if necessary, create a VDC. In order to do this, you will need to have already added a hypervisor of the same type as the one you are capturing from.
If the VM uses a public IP, purchase the appropriate public IP. Go to Virtual datacenters → select virtual datacenter → Network → Public and click the + Add button
- If you wish to add a new cost code to the VM, create the cost code in Pricing view before you capture the VM
Retrieve VMs from a physical machine
To retrieve or import VMs from a physical machine:
- Go to Infrastructure → Private → Servers
- For a new physical machine, add the physical machine and to automatically import VMs, select the Retrieve existing virtual machines checkbox
- For an existing physical machine, select the physical machine, and click the Retrieve virtual machines button
The imported VMs will appear in the list with the imported symbol . If duplicate VMs display, you may have clicked the retrieve button while an import process was already running. To remove duplicates, click the Remove unmanaged virtual machines button and then retrieve the VMs again.
Capture a VM
To onboard a VM that you already imported into the platform:
- Go to Infrastructure → Private → select a datacenter → Servers → select a physical machine
- Select the VM and on the VM details panel, click the Capture VM button
The Capture virtual machine dialog will open, listing all the compatible virtual appliances
Select the virtual appliance in the VDC with the network address, or create a new virtual appliance by clicking the + Add button.
Click Accept to capture the VM
Review the General Information of the captured VM
Optionally select a cost code for the VM
- After capture, you can reconfigure the VM to enable remote access. On vCenter, configure WebMKS access to enable hot reconfigure of remote access on captured VMs
Configure and assign the corresponding network and IP configuration to each NIC. Select a default gateway.
Review hard disks that Abiquo will capture
After reviewing the VM configuration, click Accept to continue. The platform will now capture the VM
The captured VM will have the Release VM button on its VM details panel. The platform will now fully manage captured VM.
If the virtual appliance was deployed before the capture, the new VM will be added to the virtual appliance but no other changes will be made. If the virtual appliance was undeployed (and contained VMs) before the capture, afterwards it will be deployed and in the Partially deployed state.
Configure backups
Abiquo offers optional backup plugins that support popular backup systems such as Veeam and Networker. For information about configuring these plugins, see Abiquo Backup Plugins. After the plugins are configured, you can manage Abiquo backups in Infrastructure view on the Backup policies tab as described here.
Create a Backup manager
To work with a backup system in Abiquo, first create a Backup manager to define the connection to the backup system.
Abiquo does not validate the connection details. A connection will be made to the backup system when a user requests a backup operation.
Property | Description |
---|---|
Name | Name to identify backup manager |
Type | Select the backup plugin type. After you save the backup manager, you cannot edit this attribute |
Endpoint | This is the URL for connecting to the backup system API. Tip: When adding a Veeam backup manager, don't forget to add the slash "/" at the end of the URL. Examples: Veeam 9.5u4: https://veeam.host.domain:9399/api/ |
User | User for the backup system. For Networker, and for Rubrik with vCloud you must also enter the vCenter user and the format is as follows:
By default the separator character is '#' but the administrator can change this value |
Password | Password for the backup system. For Networker, and for Rubrik with vCloud only, you must also enter the vCenter password and the format is as follows:
By default the separator character is '#' but the administrator can change this value |
Note: For networker, the vCenter credentials are mandatory. Networker uses these credentials for the "Restore a VM when it is not allocated" option
When editing the backup manager, you can modify all values except the backup type. If you change the backup manager, future requests to the backup system will use the new values.
Configure backup properties
To define the characteristics of the backups offered in the platform, configure backup properties.
Privilege: Manage datacenter backup configuration
To configure the backup properties:
- Go to Infrastructure → select a datacenter or public cloud region → Backup policies
- Click Edit properties
The backup properties are described in the following table.
Property | Description |
---|---|
Enable multiple restore | Allow users to restore a backup more than once. If enabled, when the backup status is failed or success, the Restore link in the UI will activate again. |
Enable multiple backup policies | Allow users to select more than one backup policy for a VM |
Enable update when deployed | Allow users to change backup policies and backup details when a VM is deployed |
Enable backup now | Display a Backup now button on the Backup tab that will enable users to request an immediate manual backup. |
Support for Backup now
Provider | Notes |
---|---|
Networker | Native option |
Veeam+Snapshot | Uses VMware snapshot |
VMware Snapshot | Uses VMware snapshot |
Rubrik | Native option (using VMware snapshot) |
Create Backup Policies
To enable users to configure VM backups in a datacenter, create backup policies
To create a new backup policy:
- Go to Infrastructure → select a datacenter or public cloud region → Backup policies
- Click the + Add button and enter the details as described below.
General info
Backup description
Field | Description |
---|---|
Name | Name of the backup policy that users can select |
Code | The Code that identifies the policy and that must be unique in the datacenter. Abiquo may use the Code attribute to match policies that the administrator already created in the backup system |
Description | Description of the backup policy to help users identify it |
After you enter the General info, select the backup type:
- The Abiquo backup integrations only support Complete backups
Complete backup
Example backup configuration of Complete backup
Field | Description |
---|---|
Defined hour | Backup at a defined date and time. Date format is yyy/MM/dd HH:mm:ss +0000. The Veeam backup integration does not support this option |
Daily | Backup every day at a defined time. Time format is HH:mm:ss +0000 |
Monthly | A backup every month at the defined time. When the user enters a time it is in the format HH:mm:ss, and the user must select the UTC offset. This option is designed to enable the system administrator to define the monthly backup day in the backup integration. |
Hourly | A backup at an interval of hours. Enter an integer less than 24. |
Weekly planned | A backup every week on defined days at a defined time. When the user enters a value, the format is HH:mm:ss, and the user must select the UTC offset. |
For each field in the backup type, the Cloud Admin can choose how to set the values:
Value | Description |
---|---|
Fixed | The value is set by the Cloud Admin as part of the backup policy |
Don't apply | The value is set by the backup system |
Define in VM | The user must set the value and will require the appropriate privileges |
Optional additional tenant configuration
To allow specific tenants to access backup policies and hardware profiles:
- Go to Users → edit the enterprise
- Go to Datacenters → select the Allowed datacenter or public cloud region
- Go to Hardware profiles and/or Backups as required
- Enable and/or select the desired options
For more details, see Configure an Enterprise in a Cloud Location
Copyright © 2006-2022, Abiquo Holdings SL. All rights reserved