This chapter provides an overview on how to manage user and system service add-ons in OnApp. You can view, create, edit, delete service add-ons and manage their On add, On remove, On VS Destroy and On VS Rebuild events.

  • To manage user service add-ons, ensure that Service Add-ons permissions are on. 
  • To manage system service add-ons, ensure that Manage System Service Add-ons permissions are on. For more information about permissions, refer to the Permissions section of this guide.

Create Service Add-on

When creating a service add-on, at first you specify its properties, and then attach On add, On remove, On VS Destroy, and On VS Rebuild events.

To create a service add-on:

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. 
  2. On the following page, click upper right.
  3. On the page that appears, fill in the following:
    • Label – give your service add-on a name
    • Description – add the service add-on description

    • Icon – upload the service add-on icon (click Choose file to select a necessary image)

      The icon should have width less than or equal to 200px and should have height less than or equal to 200px.

    • Available on VS provisioning - move the slider to the right to be able to choose this service add-on when creating a VS (providing that the Replace recipes permission is enabled and the billing settings allow) 

    • System service add-on - move the slider to the right to make the add-on obligatory for a user and impossible to remove

    • Compatible with – choose the OS system, with which the service add-on is compatible (Windows, Unix or both)

  4. Click Save. The service add-on will be created and you will be redirected to the Edit page, where you can manage On Add, On Remove, On VS Destroy, and On VS Rebuild events. For more details, refer to the section below. 

Service Add-on Events 

Service add-on events let you configure which actions will be run on the VS, to which the service add-on is assigned.

  • The transactions for running the On Add events will be scheduled at the moment when the service add-on is assigned to a VS. 
  • The transactions for running the On Remove events will be scheduled at the moment when the service add-on is re-assigned from a VS. 
  • The transactions for running the On VS Destroy events will be executed before 'Destroy VS' transaction. 
  • The transactions for running the On VS Rebuild events will be executed after VS rebuild. Currently the following events are available:

Run Recipe Actions

Recipes are available for service add-on configuration. The recipes will run on Virtual servers and vCloud director virtual servers.

Prerequisite

The recipes should be created beforehand, properly configured and tested.

The list of recipes that can be assigned to a service add-on depends on the user plan settings - it is possible to choose only from those recipe groups which are added to the bucket. Also it is required to have the View recipes permission to be able to attach a recipe event to a service add-on. The recipes are not filtered according to compatible with type. Make sure that the recipe Compatible with parameter and the service add-on Compatible with parameter are consistent. Otherwise, running the event will fail for a VS.

Be aware, that if you add several recipes to the event, they will be fulfilled in the top-down order.


To create a Run Recipe action:

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you want to change, then choose Edit.
  3. On the screen that follows, click  > Add Recipe Action at On add, On remove, On VS Destroy, or On VS Rebuild event menu.
  4. Choose recipe from the drop-down list.
  5. Choose destination:
    • Run on Virtual Server - choose it if you want to run this recipe action only on VS, to which this service add-on will be assigned
    • Run on Control Panel - choose it if you want to run this recipe action on the whole Control Panel. For more information, refer to Control Panel Recipes Settings.
  6. Click Add.


To edit a Run Recipe action: 

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you want to change, then choose Edit.
  3. On the page that appears, click next to the Run Recipe action you want to edit.
  4. Choose recipe from the drop-down list and click Update Action.


To delete a Run Recipe action: 

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you want to change, then choose Edit.
  3. On the following page, click next to the recipe you want to delete.
  4. Confirm the deletion.

Raise Event Actions

Raise event actions become available starting with OnApp 5.5 version. This is an action type that sends notification to all subscribed recipients. 


Notification Configuration

To configure a notification, which will be sent when adding a 'Raise Event" action, fulfill the following steps:

  1. Ensure that notifications are enabled for your cloud.
  2. Go to your Control Panel > Admin > Notifications > Recipients Lists and create a new recipient list of users whom you want to notify about certain event.

  3. Go to your Control Panel > Admin > Notifications > Notification Templates and create message text that will be sent to your users. 

    If you add a '%{message}' text to the template, the notification will contain the information about the service add-on name, VS name and identifier. For example: "The Test Service Add-on has been added to a Test Virtual Server with the ID abcdefghijk."

    If you add a '%{name}' text to the template, the notification will contain the user's name.

  4. Go to your Control Panel > Admin > Notifications > Gateways and determine in what way users will be contacted: via email or internal notifications in CP.
  5. A subscription is the final step of a notifications configuration which ties together a recipients list, a gateway and a notification template. Go to your Control Panel > Notifications > Subscriptions > New Subscription and fill in the following details:
    • Name - the label for the subscription
    • Event - select the Service addon event from the drop-down list.
    • Recipients list - select the recipients list which you have configured in the second step on this instruction.
    • Notification template - select the notifications template which you have configured in the third step on this instruction.
    • Gateway - select the gateway which you have configured in the fourth step on this instruction.
  6. Click Save.

For more information about subscriptions and messages configuration, refer to Subscriptions.

Then you have to create a Raise Event action. For this:

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you want to change, then choose Edit.
  3. On the page that follows, click > Raise Event at On add ,On remove, On VS Destroy or On VS Rebuild event menu.
  4. Click Add.


To delete a Raise Event action: 

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you want to change, then choose Edit.
  3. On the page that follows, click next to the Raise Event action you want to delete.
  4. Confirm the deletion.

Edit Service Add-on

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you want to change, then choose Edit.
  3. On the screen that follows, enter service add-on details as required:
    • Label – change the service add-on name
    • Description – edit the service add-on description
    • Icon – change the service add-on icon (click Choose File to select a necessary image)
    • Available on VS provisioning - move the slider to the right to be able to choose this service add-on when creating a VS (providing that the Replace recipes permission is enabled and the billing settings allow)

    • Compatible with – choose the OS system, with which the service add-on is compatible (Windows, Unix, or both)

  4. Click the Save button to finish.

Also you can manage On add, On remove, On VS Destroy, and On VS Rebuild events at the Edit page.  


Assign Service Add-On to VS

Service add-ons can be assigned to the VS during its creation or later.

Service add-ons in VS creation wizard

Ensure that the following requirements are met to be able to assign service add-on to VS during its creation:

  • Replace Recipes with Service Add-ons on VS creation permission is enabled
  • Service add-on groups are available in your bucket
  • The On Provisioning option is enabled for all or some of the service add-ons available to you within the bucket. 

If the requirements are met, you will get Service Add-ons step in VS creation wizard, where you should fulfill the following steps:

  1. Click the service add-on group icon on the left  to expand the list of service add-ons on the right. Every service add-on contains the following info:
    • Label
    • VS types with which this service add-on is compatible
    • Description of the service add-on
    • Price per hour
  2. Select the service add-on by clicking on it. You can select several add-ons from different service add-on groups. Click View Selected Add-ons to see the list of selected service add-ons. You can remove the selected service add-on from the list by clicking near the add-on.
  3. Click Next to proceed to the next step of the wizard that completes the virtual server creation process.


Service add-on assignment to already created VS

When the events and the prices are configured for service add-ons, you can assign a service add-on to any of their VSs.

To assign service add-on to a VS:

  1. Go to your Control Panel > Cloud > Virtual Servers menu.
  2. On the following page, click the label of the server you're interested in.
  3. Click the Overview tab, then choose Service Add-ons.
  4. On the page that appears, click upper right. You will get the list of service add-on groups (availability is configured in the bucket).
  5. Click the label of the necessary user or system service add-on to see its details:
    • Label
    • Type - user or system
    • Description
    • Price
  6. Choose the necessary service add-on and click Assign. The transaction to execute the add-on event(s) will be scheduled for running. If you rebuild VS, the On VS Rebuild event(s) will be scheduled for running and in case of VS deletion - the On VS Destroy event(s) will be scheduled for running.

For more information, refer to the Virtual Server Service Add-ons section of this guide. 

Also, you can view the list of VSs assigned to the service add-on. 

View Service Add-on Applied to VSs

You can view the list of VSs, to which the service add-on is assigned. For this:

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu. You'll see a list of service add-ons on your system.
  2. Click the Actions button next to the service add-on you are interested in, then choose Applied to VS.
  3. On the screen that follows, you will get:
    • Label - the service add-on name 
    • Description – the service add-on description
    • The list of virtual servers, to which the service add-on is assigned, if there are any

For more information on how to assign service add-on to VS, refer to the Virtual Server Service Add-ons section of this guide.

Assign System Service Add-ons to Template

If you assign a system service add-on to a template, the system service add-on will be assigned to the virtual servers later built from this template.

To assign system service add-ons to a template:

  1. Go to your Control Panel > Cloud > Templates > Template List menu. You'll see a list of templates, available on your cloud. 
  2. Next to the template in question click the Actions button and select the Manage Service Add-ons option. 
  3. On the following page, click .
  4. The screen that follows shows the list of the available system service add-ons organized into groups. Click the arrow button next to a group to expand the list of add-ons assigned to it.
  5. Click the label of the necessary system service add-on to see its details:
    • Label
    • Type - user or system
    • Description
    • Price
    • Apply to existing Virtual Servers - move the slider to the right to assign the system service add-on to all the VSs in your cloud built from this template
  6. Click the Assign button to finish. 

Please note if you rebuild a virtual server from a different OS template, all added system service add-ons will be removed from it.

System Service Add-Ons Statistics

For your convenience, the system tracks the system service add-ons' usage and generates statistics on it. It is possible to generate it for a specific period.

To generate the statistics:

  1. Go to your Control Panel > Admin > Users menu.
  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. 

Delete Service Add-on

  1. Go to your Control Panel > Cloud > Service Add-ons > Service Add-ons menu.
  2. Click the Actions button next to the service add-on you wish to delete, then choose Delete.
  3. Confirm the deletion. The transaction to execute the On remove event(s) will be scheduled.

See also:

Leave feedback