Installing Plugins

When you are ready with the configuration of your backup plugin, you can integrate it into your OnApp Control Panel. This document also provides information on installing the default plugins for R1Soft and Veeam.  

The following procedure presupposes that you have an SSH key added to your CP. For more information on SSH configuration, see Edit Defaults Configuration.

Please note that OnApp does not provide support for R1Soft 6.14 versions yet. The newest version of R1Soft we suggest you install is 6.12.0.



On this page:


Install Custom Plugin


Follow the next procedure to install your plugin to CP: 

  1. Connect to the Control Panel server via SSH.
  2. Navigate to the vendor/backups/plugins directory and create here a new directory named as your backup plugin. 

    # cd vendor/backups/plugins
    # mkdir plugin_name
  3. Navigate to the new directory and create (or upload) your config.xml and plugin.rb files.

    # cd plugin_name
    # touch config.xml
    # touch plugin.rb
  4. Restart your Apache daemon, using the following command: 

    # service httpd restart
  5. Restart OnApp services, using the following command: 

    # service monit stop
    # service onapp stop
    # service onapp start
    # service monit start


Install Plugin for R1Soft


Prerequisites:

  • Public IP-address or the Plugin Manager must be in the same subnet with agents and have access to the Internet
  • 1 GB free RAM
  • The virtual server should be running with the updated kernel, and R1soft supports this kernel (ex. for CentOS: Index of /modules/Centos_7_x64, ubuntu: Index of /modules/Ubuntu_1804_x64, etc.)
  • 1167 port opened only for the plugin manager and closed for the others.

Follow the next procedure to install the plugin for R1Soft to CP: 

  1. Go to your Control Panel > Cloud > Virtual Server menu and then click on the virtual server you want to install R1Soft for.
  2. On the Virtual Server Details page, click Backups tab Backups resources.
  3. Attach the R1soft backup plugin to the VS.
  4. Run the following command on VS:
yum -y update
yum install kernel-devel kernel-headers
echo "nameserver 8.8.8.8" >> /etc/resolv.conf

# boot VM with the new kernel
shutdown -r now

You can also install the plugin from R1Soft UI:

  1. From the Protected Machines page, click on the needed agent > Actions button > Deploy Agent Software.
  2. Fill in the form in the dialog box and then click Deploy agent.

Now you should check communication with the agent:

  1. From the Protected Machines page, click on the needed agent > Actions button > Test Agent Connection.
  2. Check communication in the dialog box.

If the communication with the agent is not successful, you need to perform the following steps inside the virtual server and retry the agent deployment:

 For Centos6
# prepare 1167 port for r1soft agent
iptables -A INPUT -p tcp -s <plugin_manager_ip_addr> --sport 1167 -j ACCEPT
service iptables save
service iptables restart
 For Centos7
sudo systemctl enable firewalld
# boot VM with the new kernel
shutdown -r now

firewall-cmd --get-active-zone
firewall-cmd --zone=<zone_name> --add-source=<plugin_manager_ip_addr> --permanent
firewall-cmd --zone=<zone_name> --add-port=1167/tcp --permanent
firewall-cmd --reload


Upgrade Plugin for R1Soft

Please note that the latest version of R1soft that we support is 6.12.0.

First, you need to update the plugin manager and then update the agent on the virtual server to a new version.


Via Plugin Manager UI, on the Protected Machines page, click on the needed agent > Actions button > Update Agent Software. Wait for the transaction to complete (Plugin Manager deploys the agent version that is equal to its own).


Install Plugin for Veeam


Before you install a plugin for Veeam, make sure that you accomplish Prerequisites.

Follow the next procedure to install the plugin for Veeam to CP: 

  1. Connect to the Control Panel server via SSH.
  2. Install the backup plugin for Veeam by running the following command: 

    # yum install onapp-cp-backups-veeam
  3. Restart your Apache daemon, using the following command: 

    # service httpd restart
  4. Restart OnApp services, using the following command: 

    # service monit stop
    # service onapp stop
    # service onapp start
    # service monit start


What's Next? 


After you completed the procedure, you can create backup resources that will use your plugin. For more information on how to manage backup resources and zones, see the following documents: 

After you install your backup plugin and create backup resources, by default users cannot access these resources on your Control Panel. To enable users to access and manage backup resources, add zones to Access Control of a bucket and enable the corresponding permissions for the User role.