SelfPortal is a service, that was created by an Altoros DevOps team in order to resolve problem with granting access to company resources for developers. It has started as a small, almost static web page, that helped developers to publish their websites into the global network, but over time became a utility, that provide wide possibilites to create virtual development environment, manage it and clear while necessary. Secure control over all the resources is a kind of main idea of our project.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
In order to get SelfPortal properly functional you need to have OpenStack and VSphere (VCenter) installations in your infrastructure and a Ubuntu Linux machine. At both installations you should have prepared Images (OpenStack) or Templates (VSphere).
Using vSphere and OpenStack in SelfPortal are optional. You can skip points 9 or 10 (or both) of this instruction respectively.
- Install NGINX, PHP (curl, json, ldap, mysqli, xml modules), MySQL/MariaDB, Perl (JSON, YAML, LWP::Protocol::https, Socket6, Switch, IO::Socket::SSL modules).
sudo -i
apt install nginx php php-curl php-json php-ldap php-mysqli php-xml -y
apt install mysql-server
apt install make gcc libssl-dev
cpan install CPAN
cpan reload cpan
cpan install JSON
cpan install YAML
cpan install LWP::Protocol::https
cpan install IO::Socket::SSL
cpan install Switch
cpan install Socket6Do not hesitate to use php -m to verify and check all php libraries installed.
-
Create log folder, grant writing access to www-data and setup logrotate as well.
-
Clone this repo to /var/www/selfportal. Import database from /var/www/selfportal/db/portal.sql
-
Setup nginx to display selfportal at /var/www/selfportal. It's better to use https, you know it.
-
Rename /var/www/selfportal/config/config.php.example to /var/www/selfportal/config/config.php, change all values in accordance to your infrastruscture settings.
-
Copy config/sites-enabled/proxy.conf to /etc/nginx/sites-enabled/proxy.conf. Setup writing access for www-data.
-
Use sudo visudo command to add line to sudouers file:
www-data ALL=NOPASSWD: /usr/sbin/nginx, /usr/bin/crontab, /bin/grep
- Optional. If you want SelfPortal to terminate your VMs - please, add those lines to the root crontab:
0 8 */1 * * /usr/bin/php /var/www/selfportal/modules/tasks.php --action notify
1 0 */1 * * /usr/bin/php /var/www/selfportal/modules/tasks.php --action disable
5 0 */1 * * /usr/bin/php /var/www/selfportal/modules/tasks.php --action delete
10 0 */1 * * /usr/bin/php /var/www/selfportal/modules/tasks.php --action shutdown_vm
15 0 */1 * * /usr/bin/php /var/www/selfportal/modules/tasks.php --action terminate_vm
- Optional. Install Python OpenStack client. Go to https://pypi.python.org/pypi/python-openstackclient for details.
sudo -i
apt install python-pip
pip install python-openstackclient- Optional. Install VMWare vSphere Perl SDK (download it from vmware.com. Here is a link for VSphere 6.0 SDK).
Prerequisites:
sudo apt-get install lib32z1 build-essential gcc uuid uuid-dev perl libssl-dev perl-doc liburi-perl libxml-libxml-perl libcrypt-ssleay-perlExtract the archive you've downloaded from VMWare website. Install SDK executng vmware-install.pl file.
sudo vmware-vsphere-cli-distrib/vmware-install.plThere are two common issues in the installation proccess:
-
While executing vmware-install.pl file you will be prompted to install required dependencies. When you will agree to do this - each dependency will be install for 1-2 minutes. But one of them, called Soap::Lite will be installed. Нажать Ctrl+C один раз.
-
Perl will throw warnings, until you change one line at /usr/share/perl//VMware/VICommon.pm, where is a version of your Perl. For 6.0 - it was a line #2332.
Original line:
return defined $user_agent->cookie_jar and $user_agent->cookie_jar->as_string ne '';Line to replace:
return (defined $user_agent->cookie_jar and $user_agent->cookie_jar->as_string ne ''); You can use install.sh file for semi-automatic install. Nevertheless, you'll still have to install Perl SDK (last point of instruction) manually.
Once deployed, you can open SelfPortal at your web browser. The login window will appear:
But do not hurry to celebrate - it's just a static web page, that doesn't require even a database connection. Input your credentials and press "Login" button. If the following window appears without causing any problems, such as incessant page refreshing, you're probably installed everything correctly.
But, just to be sure, lets start some virtual machines:
Warning! VSphere VM creation is asynchronous and OpenStack is not. This part of instruction is based on VSphere VM creation.
Just wait a little (VM creation time is really depends on multiple conditions, such as image size, host performance and so on), then press refresh icon at the top right corner of the page. If your VCenter shows, that VM is ready, but SelfPortal (within a time of one minute) it doesn't - you've probably forgot to add www-data permissions to modify root crontab.
That's it! Now you can check your notifications...
...or go to admin panel and check the VMs of other users (if you have sufficient permissions, of course:wink:).
We are freely opened to any contributor, who wants to help us to improve our product.
- Alex Merguriev - Idea, initial development - Merguriev
- Arsenii Petrovich - Initial&Further development, bug fixing - Petrovich
See also the list of contributors who participated in this project.
This project is licensed under Apache 2.0 License. See license file for details.
- VMWare code examples are widely used in this project.
- Great thanks to Vittorio Pavesi and hist this post particularly, which has guided us through creating VNC console for our portal.
- VMWare and OpenStack communities topics have helped us a lot.
- PHPMailer is used to notificate users and admins team.
- Bootstrap in concatenation with Font Awesome Icons is a libraries we've based on. SB Admin - is a template we used.
- jQuery, jQueryUI, MetisMenu, DataTables - all of this is used to make picture beautiful for you.
- Acrhitecture&Interface
- Splitted rights between user and administrator, admin panel
- HTTP website proxy, blacklist
- User list in admin panel
- OpenStack provider - VM creation, modification, deletion
- VSphere provider - VM creation, modification, deletion
- Terminator - delete old unused websites and VMs
- HTTPS website proxy using wildcard certificates
- WebSocket proxy
- VMs Backups
- Mounting ISO images to VSphere VMs
- Info for users about why vSphere VM was failed to create