Control plane exposes CLI commands that allow the deployment owner to manage tenants and their users. Control plane is applicable only to multi-tenant deployments.

👍

Tenant

A tenant in a multi-tenant deployment is an organization that shares the same AI GO! instance with others organizations but has its data and configurations logically separated and securely isolated. This ensures each tenant accesses only their own information and custom settings, while benefiting from a cost-effective, shared platform.

Prerequisites

Create a .env with the contents below and follow the steps.

1. AI GO! URL: AI GO! is required to be running. Set the environment variable LF_AIGO_URL to this value.
2. Owner Key: Control plane requires the key of the deployment owner, not the user API key that only allows operations within a tenant. Owner key is set when deploying the instance as an environment variable LF_OWNER_KEY in docker-compose.yaml.
3. [OPTIONAL] SSL Flag: You can optionally also turn on or off the SSL verification of the requests sent to the AI GO! instance. The SSL is turned on by default. If you want to turn it off, set LF_VERIFY_SSL=False.

LF_AIGO_URL=<aigo_url>
LF_OWNER_KEY=<owner_key>
# LF_VERIFY_SSL=False

Run all control plane commands from the same directory.

Guides

For all CLI commands, refer to the reference of lf tenant.

List all tenants in the AI GO! instance.

lf tenant list

Create a tenant.

lf tenant add --name "My Org" --alias "my-org" --domains "myorg.one,myorg.two"

Create a user. Once a new user is created share the temporary password with the designated person.

lf tenant add-user --tenant-alias "my-org" --email "[email protected]" --name "John Doe" --roles "admin,member"

Reset a user password.

lf tenant reset-password --tenant-alias "my-org" --email "[email protected]"