What do I neet to know to setup multitenant installation?

Setting Up a Multitenant Installation

Commercial Feature: Multitenant installation is only available as a commercial feature.
Configuration: Set the MULTI_TENANT = yes variable in your environment or within the Helm chart values:
```
config:
  multiTenant:
    multi: "yes"
```
Configure the Tenant Management Service (TMS): Tracardi's multi-tenant setup relies on a dependent system called the Tenant Management Service (TMS). You will need to provide the necessary configuration details for the TMS to integrate it with Tracardi. Specifically, you need to provide the following to the tracardi-api docker/helmchart:
MULTI_TENANT_MANAGER_URL: This is the URL of the Tenant Management Service (TMS). Set it to the appropriate endpoint where the TMS is running.
MULTI_TENANT_MANAGER_API_KEY: Provide the API key for the TMS. This is used for authentication and authorization between Tracardi and the TMS.

In helm chart installation this can be set in:

secrets:
  tms:
    secretKey: "xxx"
    apiKey: "yyy"

Domain Requirement: You need a domain connected to the Tracardi API. All subdomains must point to the Tracardi API.

Kubernetes Ingress Setup: If your installation use k8s ensure that the ingress routes all subdomains to both the public and private Tracardi APIs:

  private:
    replicas: 1
    service:
      port: 8686
    ingress:
      enabled: true
      host: "*.your-domain.com"
  public:
    replicas: 1
    service:
      port: 8585
    ingress:
      enabled: true
      host: "*.your-domain.com"

Adding a Tenant: Once Tracardi is installed, add a new tenant via the Tenant Management System (TMS) API.

Creating a New Tenant via API

Prerequisites: TMS API Key, generated during TMS installation.
API Endpoint: Use the POST method to call /tenant/install.

Payload:

{
  "name": "name-of-the-tenant",
  "tms_api_key": "TMS-API-KEY",
  "email": "tenant@email",
  "password": "Admin account password",
  "needs_admin": true,
  "update_mapping": false
}

Example CURL Command:

curl -X POST \
  https://tracardi-api-url/tenant/install \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "name-of-the-tenant",
    "tms_api_key": "TMS-API-KEY",
    "email": "tenant@email",
    "password": "Admin account password",
    "needs_admin": true,
    "update_mapping": false
  }'

Result

A new tenant will be created with the specified name, which forms the subdomain for the tenant (name-of-the-tenant.your-domain.com). An admin account will also be created.

After adding a tenant, use the private API (port 8686) to manage the tenant.

Domain and Tenant Mapping

The tenant's ID becomes part of the subdomain URL and is used to identify the appropriate namespace for the tenant. The tenant API must be accessed through a subdomain.