This guide is designed for you to learn the basics of plugin development for OnApp Backup Plugin System. The system enables you to integrate OnApp with a third-party service that you use for backup management. 

Backup Plugin System is available in preview mode and is subject to change in the future OnApp releases. OnApp provides the plugin for R1Soft Server Backup Manager 6.4.1 that you can install to your Control Panel. With the help of this guide, you will be able to create your own plugin for a backup service of your choice.

Before You Begin

Before you proceed to the guide, make sure that you have:

  • An IDE or text editor
  • Basic knowledge of XML
  • Sufficient knowledge of Ruby
  • Access to your backup service
  • Knowledge of a backup product for which you create a plugin
  • SSH key added to OnApp CP

About This Guide

The guide walks you through the following steps to get your plugin up and running:

By the end of this guide, you will have your backup plugin built and published to OnApp Control Panel. 

Important Terms

Below you can find a list of frequently used terms with definitions: 

  • Provider - a company or service that provides a plugin for OnApp Backup Plugin System.

  • Backup Resource - a backup system that is based on a plugin and is used by one or multiple zones to back up virtual servers. Backup resources handle information on how to access a third-party backup service (i.e. host, username, password, etc). 

  • Auto Backup Preset - a preconfigured schedule to determine when backups are automatically run.

  • Schedule - a copied auto backup preset that is assosiated with a backup resource and a virtual server to which the resource is assigned. 

  • Recovery Point - a point-in-time backup from which a virtual server can be restored. 

Additional Information

To learn how to use a plugin and manage backup resources on OnApp Control Panel, dive into the following documents from Administration Guide: 

To find API information on backup resources and zones, refer to the following documents from API Guide: 


    Add new comment