vCloud Director VS Service Add-ons

Service Add-ons functionality allows you to offer to your customers additional services on top of your current IaaS Virtual Server offering.

 Before managing service add-ons, ensure that:

  1. vCloud Director is added to OnApp UI.
  2. RabbitMQ settings are set in config/rabbit_mq/vcloud/credentials.yml.
  3. Login and password are set for vCenter (Control Panel should have access to vCenter directly) in Admin > Settings > Compute resources > Compute resource's label > Tools > vCenter passwords.
  4. Guest customization is enabled on a vCloud Director VS and Admin Password is set.

When you have the service add-on functionality enabled in your license and everything is properly configured, you can assign service add-on to your vCloud Director VS.

You can monitor the total cost for all service add-ons inside the company. For this, go to your Control Panel’s > Admin > Groups > your User group’s label > Groups link.

  • To manage user service add-ons for a VS, ensure that Manage Service Add-ons for all virtual servers and/or Manage Service Add-ons for own virtual servers permissions are enabled. 
  • To manage system service add-ons for a VS, ensure that Manage System Service Add-ons and/or Manage own System Service Add-ons  permissions in the Virtual Servers section are enabled. For more information about permissions refer to the Permissions section.

View VS service add-ons



To view virtual server service add-ons:

  1. Go to your Control Panel > Cloud > Virtual Servers menu.
  2. Click the label of the server you're interested in.
  3. Click the Overview tab, then choose Service Add-ons.
  4. The screen that follows shows details of all the service add-ons assigned to the VS, if there are any:
    • Label - the service add-on name (by clicking on it you can edit the service add-on)
    • Price  - the service add-on price, set for this service add-on in the Service Add-on Store
    • Status  - whether the service add-on is active or not
    • Actions icon - you can unassign the Service Add-on from this Virtual Server by clicking the Delete icon.

Also, if any service add-on is already assigned to the VS, you can view it at the VS's details page.



Assign service add-on to the VS



To assign service add-on to the VS:

  1. Go to your Control Panel > Cloud > Virtual Servers menu.
  2. Click the label of the server you're interested in.
  3. Click the Overview tab, then choose Service Add-ons.
  4. Click the "+" button at the upper right corner. You will get the list of service add-on groups (availability is configured in the bucket). The transaction to execute the On add event(s) will be scheduled for running.
  5. Choose the necessary service add-on and click Assign

Alternatively, if any service add-on is already assigned to the VS, you can assign another one at the VS's details page.



Unassign service add-on from the VS



To unassign service add-on from the VS:

  1. Go to your Control Panel > Cloud > Virtual Servers menu.
  2. Click the label of the server you're interested in.
  3. Click the Overview tab, then choose Service Add-ons.
  4. Click the "Delete" icon next to the service add-on you want to unassign. Confirm the deletion. The transaction to execute the On remove event(s) will be scheduled

Alternatively, you can unassign the service add-on at the VS's details page.


Generate statistics for system service add-ons



You may generate the statistics for the system service add-ons usage for a specified period. To generate the statistics:

  1. Go to your Control Panel > Admin > Users.
  2. Click the Full Name of the cloud admin to get to the User Profile
  3. In the Billing Details section, click the System Service Add-ons Report button. 
  4. Select the time period from the drop-down menu and click the Apply button to generate the report. 
  5. On the page that appears you will see the report with the following details:
    • From - the beginning of the specified time period for the statistics generation
    • Till - the end of the specified time period for the statistics generation
    • Virtual server - the VS the system service add-on in question is assigned to
    • Cores (peak usage) -  the number of CPU cores used 
    • Memory (peak usage) - RAM usage, GB
    • Disk size (peak usage) - disk usage, GB

You can save your billing statistics to a file in a CSV format. To download a CSV file with billing statistics for a selected period of time, click the Save as CSV button. The download will start automatically after you click the button.

The CSV file includes the following information:

  • from - the beginning of the specified time period for the statistics generation
  • till - the end of the specified time period for the statistics generation
  • user_id - the ID of the user 
  • virtual_machine_id - the ID of the VS the system service add-on in question is assigned to
  • service_addon_id - the ID of the system service add-on
  • cpus - the number of CPU cores used
  • memory - RAM usage, GB
  • disk_size - disk usage, GB

The generated reports will be stored at the System Service Add-ons Report page. However, if you have statistics archiving enabled for your cloud, the reports will be stored according to the period, specified for the archiving. 

For Windows-based VSs, you may also generate an SPLA report on the system service add-ons usage. For more information, refer to the SPLA Report section of this guide.