OpenStack UI Plugin


Integration with the Openstack interface is our second plugin alongside the oVirt/RHV virtualization family. Thanks to it, you can perform most of the basic operations without logging into the vProtect dashboard.
After installation (which is described at the end of this article) you will see a new tab "vProtect" in the OpenStack menu.


The dashboard consists of several tabs that allow you to perform basic actions such as backup, restore or create a new schedule.


This tab shows all inventoried instances in your OpenStack environment.
Besides, you can also perform basic backup operations.


This tab displays all instances in the OpenStack environment that can be restored.
Restore window:


As the name suggests, this tab allows you to create schedules, but not only.
Thanks to it, we will also create the policies necessary for their operation.


Basic information about current tasks performed by vProtect.

OpenStack general integration setup

You can find the add-on in the GitHub repository. Extract the provided archive on to your Horizon host and execute python VPROTECT_API_URL USER PASSWORD
Example: python http://localhost:8080/api admin vPr0tect.
Note: you need to restart your Horizon HTTP server after this
The above-mentioned script will copy the plug-in files to the following folders:
  • /usr/share/openstack-dashboard/openstack_dashboard/dashboards/vprotect - plugin files
  • /usr/share/openstack-dashboard/openstack_dashboard/enabled - file to enable plugin
In order to uninstall it, remove the vprotect subfolder and enabled/ file and restart your Horizon HTTP server.

Integrate vProtect dashboard plugin to OpenStack (LXC)

  • git, python3-yaml packages
  • internet connection
  1. 1.
    Check name of the horizon container:
    lxc-ls -f | grep horizon
    [[email protected] ~]# lxc-ls -f | grep horizon aio1_horizon_container-b2daccaa RUNNING 1 onboot, openstack, - false
  2. 2.
    Enter horizon container:
    [[email protected] ~]# lxc-attach aio1_horizon_container-b2daccaa
  3. 3.
    Install requirements packages:
    [email protected]:~# apt install python3-yaml git -y
  4. 4.
    Clone from github instalations files:
    [email protected]:~# git clone
  5. 5.
    Change owner of the plugin directory to horizon:horizon
    [email protected]:~# chown -R horizon:horizon openstack-horizon-ui-vprotect-extensions
  6. 6.
    Enter plugin directory:
    [email protected]:~# cd openstack-horizon-ui-vprotect-extensions
  7. 7.
    Optionally you can ping vprotect server by ping
    [email protected]:~# ping vprotect-server-IP-ADDRESS
  8. 8.
    Next, install the plugin
    [email protected]:~# python3 http://vprotect-ip:8080/api admin_user admin_password
    When the installation process is completed, plugin files should be placed in /usr/share/openstack-dashboard/openstack_dashboard directory. If your path to dashboard directory is different, create symbolic links from plugin install directories to non-standard directories.
    [email protected]:~# ln -s /usr/share/openstack-dashboard/openstack_dashboard/dashboards/vprotect /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/openstack_dashboard/dashboards/
    [email protected]:~# ln -s /usr/share/openstack-dashboard/static/vprotect /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/static/
    [email protected]:~# ln -s /usr/share/openstack-dashboard/openstack_dashboard/enabled/ /openstack/venvs/horizon-23.1.0.dev42/lib/python3.8/dist-packages/openstack_dashboard/enabled/
  9. 9.
    Edit /etc/apache2/sites-available/openstack-dashboard.conf file:
    • Add alias for static files
    Alias /dashboard/static /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/static/
    • Directory tag informs you, where dashboards directories should be placed.
    • Second Directory tag informs where static directory from plugin should be placed
    Example configuration file should look like this:
    # Ansible managed
    # If horizon is being served via SSL from this web server,
    # then we must redirect HTTP requests to HTTPS.
    # If horizon is being served via SSL via a load balancer, we
    # need to listen via HTTP on this web server. If SSL is not
    # enabled, then the same applies.
    ServerName aio1-horizon-container-b2daccaa.openstack.local
    LogLevel info
    ErrorLog syslog:daemon
    CustomLog "|/usr/bin/env logger -p []( -t apache2" "%h %l %u \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
    Options +FollowSymLinks
    RequestHeader set X-Forwarded-Proto "https"
    WSGIScriptAlias / /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/openstack_dashboard/
    WSGIDaemonProcess horizon user=horizon group=horizon processes=1 threads=1 python-path=/openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/site-packages
    WSGIProcessGroup horizon
    WSGIApplicationGroup %{GLOBAL}
    <Directory /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/openstack_dashboard>
    <Files >
    <IfVersion < 2.4>
    Order allow,deny
    Allow from all
    <IfVersion >= 2.4>
    Require all granted
    Alias /static /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/static/
    Alias /dashboard/static /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/static/
    <Directory /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/static/>
    Options -FollowSymlinks
    <IfVersion < 2.4>
    AllowOverride None
    Order allow,deny
    Allow from all
    <IfVersion >= 2.4>
    Require all granted
  10. 10.
    Edit /openstack/venvs/horizon-23.1.0.dev65/lib/python3.8/dist-packages/openstack_dashboard/ and add in urlPatterns following line
    url(r'^dashboard/', horizon.base._wrapped_include(horizon.urls))
    Your should looks like:
    URL patterns for the OpenStack Dashboard.
    from django.conf import settings
    from django.conf.urls import include
    from django.conf.urls.static import static
    from django.conf.urls import url
    from django.contrib.staticfiles.urls import staticfiles_urlpatterns
    from django.views import defaults
    import horizon
    import horizon.base
    from horizon.browsers import views as browsers_views
    from horizon.decorators import require_auth
    from openstack_dashboard.api import rest
    from openstack_dashboard import views
    urlpatterns = [
    url(r'^$', views.splash, name='splash'),
    url(r'^api/', include(rest.urls)),
    url(r'^header/', views.ExtensibleHeaderView.as_view()),
    url(r'', horizon.base._wrapped_include(horizon.urls)),
    **url(r'^dashboard/', horizon.base._wrapped_include(horizon.urls)),**
    # add URL for ngdetails
  11. 11.
    Restart httpd service
    /etc/init.d/apache2 restart
  12. 12.
    After refreshing dashboard site you should see vProtect button in Openstack menu.