LEIP Enterprise

LEIP Enterprise provides a web application to analyze and graph metrics from all your LEIP experiments. For this to happen, you need to deploy the application either on-premise or on the cloud, and connect to it from the LEIP SDK container.

Local Server Setup

Prerequisites

• Docker Compose.

• Python 3.

• Your license key and access to the Latent AI container registry. You may contact support@latentai.com for assistance.

We recommend that you have at least 4 GB of RAM available to Docker.

Installation Files

Download the following files to a directory called leip-enterprise on your computer:

docker-compose.yml configure.py

Configuration

Configuration is provided through a .env file. To generate it, run the configure.py script. This script will interactively ask you some details to generate the file. After this, you may optionally inspect and change some values in it.

Here’s an example run:

% cd leip-enterprise
% python configure.py
***** Latent AI, Inc.
***** LEIP Enterprise configuration script
*****   This script will generate a new .env file with safe passwords that will be used when you start the server.
*****   IMPORTANT: Any previous instances will have to be taken down with: docker compose down -v

Do you wish to continue? (yes/no) [Default: no]: yes
Do you want to include sample data (50 experiments)? (yes/no) [Default: no]: no
Do you want to configure the SMTP service for sending emails?
  This is used to send account info to all LEIP Enterprise users, but it's optional.
  Note: A dedicated email account should be used for this.
  (yes/no) [Default no]: yes
    SMTP TLS (yes/no) [Default: no]: yes
    SMTP Host: smtp.gmail.com
    SMTP Port: 587
    SMTP User: noreply@example.com
    SMTP Password: smtp-password

.env file was written.

You can now start the server with: docker-compose up -d
And take it down without losing data with: docker-compose down
You will access LEIP Enterprise UI at http://localhost
Your username is <user> and your password is <password>

Alternatively, you can also include kibana service with: docker-compose --profile kibana up -d
And take it down without losing data with: docker-compose --profile kibana down
You will access Kibana UI at http://localhost:5601
In that UI, your username is <user> and your password is <password>

After running the script you will see your administrator account for the LEIP Enterprise UI, and the optional account for the Kibana UI.

Pulling the Docker Containers

Login to the Latent AI container registry:

docker login registry.latentai.io

Pull the containers:

docker-compose pull

Optionally, if you want to pull a specific version:

TAG=<version> docker-compose pull

Starting the Docker Containers

Start services with:

docker-compose up -d

Alternatively, if you also wish to use the kibana service, start with:

docker-compose --profile kibana up -d

After about 30 seconds, all services should be ready, and the locally deployed application will be available at http://localhost.

Stopping the Docker Containers

When you need to stop the services, run:

docker-compose down

If you included kibana service, you should stop with:

docker-compose --profile kibana down

UI Access

At this point, you may open the LEIP Enterprise UI at http://localhost and login with your configured administrator account from the output of the configuration script.

If you accepted the inclusion of sample data, you can visualize those already.

Before you configure your LEIP SDK container to send events to LEIP Enterprise, you may want to add a new user, a project, and permissions between them, so that you can associate events with that user and project. To create them, use the configuration button on the top right and click “Configure users” and/or “Configure projects”.

LEIP SDK Container Setup

To easily connect your LEIP SDK container to LEIP Enterprise, determine the name or hash of your running SDK container (usually leip) and then run this (outside of the container):

docker network connect leip-enterprise_net leip

And then, switch back to the SDK container and configure LEIP Enterprise by running:

leip enterprise init 

Here you will set these values:

• Server host: http://backend:8080.

• Username: admin (or any user you previously set in LEIP Enterprise UI).

• Password: the password for admin, indicated in the output of the configuration run, or the password set by you in the LEIP Enterprise UI.

• Project: Select a project from the list (if you created one and gave the user permission) or just select <None>.

You may change any of these values at any time using individual commands (See leip enterprise --help for details).

General Usage

After the LEIP Enterprise server is up and a LEIP SDK container is configured, you may run any LEIP commands on the LEIP SDK container as usual and will be able to visualize metrics data on the LEIP Enterprise application.