Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 6.28 KB

README.md

File metadata and controls

106 lines (74 loc) · 6.28 KB
Raw

ZEVENET Load Balancer

This is the repository of ZEVENET Load Balancer Community Edition (Zen Load Balancer CE next generation) and it'll guide you to install a development and testing instance of load balancer.

Repository Contents

In this repository you'll find the source code usually placed into the folder /usr/local/zenloadbalancer/ with the following structure:

  • app/: Applications, binaries and libraries that ZEVENET Load Balancer requires.
  • backups/: Default folder where the configuration backups will be placed.
  • config/: Default folder where the load balancing services, health checks and network configuration files will be placed.
  • etc/: Some system files to configure ZEVENET Load Balancer services.
  • logs/: Default folder where the logs will be placed.
  • www/: Frontend and Backend source files of ZEVENET Load Balancer.
  • zlb-debian-installer.sh: Script to automate the installation of ZEVENET Load Balancer over a Fresh Debian Jessie installation.
  • other: License and this readme information.

ZEVENET Load Balancer Installation and Updates

Currently, there is only available the installer for Debian Jessie.

Requirements

Please, take into account these requirements before installing the load balancer:

  1. You'll need at least 1,5 GB of storage.

  2. Install a fresh and basic Debian Jessie (32 bits) system with openssh and the basic system tools package recommended during the distro installation.

  3. Configure the load balancer with a static IP address. ZEVENET Load Balancer doesn't support DHCP yet.

  4. Configure the apt repositories in order to be able to install some dependencies.

Installation on Debian Jessie

Get a Debian ISO installable from debian.org. This installation process has been only tested with the 32 bits version.

Follow the instructions to fully install the distro, taking care of the requirements listed above.

Once a fresh installation has been finished, reboot the system and login with root user. Execute the following commands in a shell terminal in order to install the git package and run the ZEVENET Load Balancer installer.

apt-get install git
cd /usr/local
git clone https://github.com/zevenet/zlb.git
cd /usr/local/zlb
./zlb-debian-installer.sh

The installer script will install all the dependencies from the apt repository, it'll migrate the network configuration and some perl libraries from CPAN. Answer yes to all questions to proceed with the installation of every component.

If the installation was successful, just perform a reboot and access to the web panel according to the Access section from the Administration Guide

Updates

The source code is able to be updated just updating the repository under the /usr/local/zlb directory.

git pull

Note that some setup could be needed in order to enable certain options that will be included in the installers.

How to Contribute

You can contribute with the evolution of the ZEVENET Load Balancer in a wide variety of ways:

  • Creating content: Documentation in the GitHub project wiki, doc translations, documenting source code, etc.
  • Help to other users through the mailing lists.
  • Reporting and Resolving Bugs from the GitHub project Issues.
  • Development of new features.

Reporting Bugs

Please use the GitHub project Issues to report any issue or bug with the software. Try to describe the problem and a way to reproduce it. It'll be useful to attach the service and network configurations as well as system and services logs.

Development & Resolving Bugs

In order to commit any change, as new features, bug fix or improvement, just perform a git clone of the repository, git add when all the changes has been made and git commit when you're ready to send the change.

During the submit, please ensure that every change is associated to a logical change in order to be easily identified every change.

In the commit description please use the following format:

[CATEGORY] CHANGE_SHORT_DESCRIPTION

OPTIONAL_LONGER_DESCRIPTION

SIGNED_OFFS

MODIFIED_FILES

Where:

  • CATEGORY is either: Bugfix for resolving bugs or issues, Improvement for enhancements of already implemented features or New Feature for new developments that provides a new feature not implemented before.
  • CHANGE_SHORT_DESCRIPTION is a brief description related with the change applied and allows to identify easily such modification. If it's related to a bug included in the Issues section it's recommended to include the identification reference for such bug.
  • OPTIONAL_LONGER_DESCRIPTION is an optional longer description to explain details about the change applied.
  • SIGNED_OFFS is the Signed-off-by entry where the username followed by the email can be placed.
  • MODIFIED_FILES are the list of files that hace been modified, created or deleted with the commit.

Usually, executing git commit -a -s will create the fields described above.

Finally, just execute a git push and request a pull of your changes. In addition, you can use git format-patch to create your patches and send them through the official distribution list.

Creating & Updating Documentation or Translations

In the official GitHub wiki there is available a list of pages and it's translations. Please clone the wiki, apply your changes and request a pull in order to be applied.

Helping another Users

The official distribution list could be accessed through the zevenet-ce-users google group.

To post in this group, send email to [email protected].

But you need to request a join first into the group by sending an email to [email protected].

To unsubscribe from this group, send email to [email protected]

For more options, visit https://groups.google.com/a/zevenet.com/d/optout

www.zevenet.com