Libra Command Line Client¶

From Ubuntu Package via PPA¶

1. Install utility

sudo apt-get install python-software-properties

2. Add the PPA

sudo apt-add-repository ppa:libra-core/ppa

3. Update the package indexes

sudo apt-get update

4. Install packages

sudo apt-get install python-libraclient

From PyPI¶

The python-libraclient package is published on PyPI and so can be installed using the pip tool, which will manage installing all python dependencies.

pip install python-libraclient

Setup the client from source¶

If you want the latest version, straight from github:

git clone git@github.com:stackforge/python-libraclient.git
cd python-libraclient
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py install

Setup the client in development mode¶

Installing in development mode allows your to make changes to the source code & test directly without having to re-run the “python setup.py install” step. You can find out more about this in the Development Mode online docs.

git clone git@github.com:stackforge/python-libraclient.git
cd python-libraclient
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py develop

Synopsis¶

libra [GENERAL OPTIONS] [COMMAND] [COMMAND_OPTIONS]

Description¶

libra is a utility designed to communicate with Atlas API based Load Balancer as a Service systems.

Global Options¶

--help, -h¶

Show help message and exit

--debug¶

Turn on HTTP debugging for requests

--insecure¶

Don’t validate SSL certs

--os_bypass_url <os_bypass-url>¶

URL to use as an endpoint instead of the one specified by the Service Catalog

--service_type <service-type>¶

Alternative service type to use for your cloud provider (default is ‘hpext:lbaas’)

--os_auth_url <auth-url>¶

The OpenStack authentication URL. Default is OS_AUTH_URL or LIBRA_URL environment variables

--os_username <auth-user-name>¶

The user name to use for authentication. Default is OS_USERNAME or LIBRA_USERNAME environment variables

--os_password <auth-password>¶

The password to use for authentication. Default is OS_PASSWORD or LIBRA_PASSWORD environment variables

--os_tenant_name <auth-tenant-name>¶

The tenant to authenticate to. Default is OS_TENANT_NAME or LIBRA_PROJECT_ID environment variables

--os_region_name <region-name>¶

The region the load balancer is located. Default is OS_REGION_NAME or LIBRA_REGION_NAME environment variables

Client Commands¶

Create Load Balancer¶

libra --os_auth_url=https://company.com/openstack/auth/url \
--os_username=username --os_password=pasword --os_tenant_name=tenant \
--os_region_name=region create --name=my_load_balancer \
--node 192.168.1.1:80 --node 192.168.1.2:80

This example will create a basic load balancer which will listen on port 80 and direct traffic in a round-robin fashion to two nodes, 192.168.1.1 and 192.168.1.2. Both these nodes are web servers listening on port 80. The Libra Client will then return a table similar to the below:

Create a Load Balancer with Node Options¶

libra --os_auth_url=https://company.com/openstack/auth/url \
--os_username=username --os_password=pasword --os_tenant_name=tenant \
--os_region_name=region create --name=my_load_balancer \
--node 192.168.1.1:80:weight=1 --node 192.168.1.2:80:weight=2

Nearly identical to the above example, this creates a new load balancer with two nodes, but one is more heavily weighted than the other, causing it to accept more traffic.

Create a Shared Load Balancer¶

It is possible for a single logical load balancer to balancer traffic for both HTTP and HTTPS for a site. For this example we will add an HTTPS load balancer to the load balancer we created previously:

libra --os_auth_url=https://company.com/openstack/auth/url \
--os_username=username --os_password=pasword --os_tenant_name=tenant \
--os_region_name=region create --name=my_load_balancer \
--node 192.168.1.1:443 --node 192.168.1.2:443 --protocol=TCP --port=443 \
--vip=52

We have taken the IP ID which was provided in the original create and given this as a VIP number in the command. We are also setting to TCP mode so the SSL termination happens at the web server and set the load balancer to listen on port 443. The result is as follows:

Add a Node¶

libra --os_auth_url=https://company.com/openstack/auth/url \
--os_username=username --os_password=pasword --os_tenant_name=tenant \
--os_region_name=region node-add 158 --node=192.168.1.3:443

In this example we have take the ID of the load balancer of the previos example to add a web server to. The result should look something like this: