Skip to content

Preconfiguration

Note

This process is not required if you do not want to preconfigure Tracardi installation. Preconfiguration is done for multitenant installation when you want to preconfigure each tenant's instance with some event-sources, resources and destinations.

Info

This feature is available from version 1.0.1

Overview

This guide details the process of preconfiguring event sources, destinations, and resources using Helm values. By doing so, every new instance of Tracardi will have predefined sources, resources, and destinations that are locked and cannot be changed or deleted. This commercial feature facilitates the setup of these configurations in advance, ensuring smooth deployment and consistent operation.

Prerequisites

  • Helm installed on your system.
  • Access to the graphical user interface (GUI) to retrieve the JSON configuration for resources, event sources, and destinations.

Steps to Preconfigure Resources, Event Sources, and Destinations

Step 1: Retrieve JSON Configuration

First, obtain the JSON configuration for your resources, event sources, and destinations from the GUI. Ensure your system is properly configured and running smoothly. For example, to get the configuration for event sources, navigate to the event sources section, select the desired event source, and click the "JSON" button to display the current configuration. You will need this JSON configuration to predefine your system settings.

Step 2: Define Helm Values

To preconfigure these settings using Helm, you will need to modify your Helm custom values file. Here is how you can do it:

  1. Configuration Structure:
    Example of preconfiguration
    config:
  preConfiguration:
    eventSources: |-
      {
        "4e755b56-3bd6-4da2-897a-d6de654881c1": {
          "id": "4e755b56-3bd6-4da2-897a-d6de654881c1",
          "name": "Tracardi.com",
          "production": true,
          "running": true,
          "type": [
            "rest"
          ],
          "bridge": {
            "id": "778ded05-4ff3-4e08-9a86-72c0195fa95d",
            "name": "REST API Bridge"
          },
          "timestamp": "2024-01-16T16:20:18",
          "description": "Collector to Tracardi.com web page",
          "channel": "Webpage",
          "enabled": true,
          "transitional": false,
          "tags": [
            "rest",
            "api"
          ],
          "groups": [],
          "permanent_profile_id": false,
          "requires_consent": false,
          "manual": null,
          "locked": true,
          "synchronize_profiles": true,
          "config": {
            "static_profile_id": false
          }
        }
      }
    resources: |-
      {
        "resource_id_1": {
          "id": "resource_id_1",
          // Configuration
          "locked": true
        }
      }
    destinations: |-
      {
        "destination_id_1": {
          "id": "destination_id_1",
          // Configuration
          "locked": true
        }
      }

Note that each element in the preconfiguration, such as a destination, has a key that matches the destination ID and includes a locked attribute set to true.

How to index configurations.
    config:
       preConfiguration:
          destinations: |-
             {
               "destination_id_1": {
                 "id": "destination_id_1",
                 // Configuration
                 "locked": true
               }
             }

Explanation:

  • config.preConfiguration: Contains the JSON configuration for event sources, resources, and destinations.
  • eventSources: JSON object defining the event sources. Each event source must have a unique key (ID) and its configuration.
  • resources: JSON object defining the resources. Each resource must have a unique key (ID) and its configuration.
  • destinations: JSON object defining the destinations. Each destination must have a unique key (ID) and its configuration.
  • locked: Attribute must be set to true to ensure the configuration cannot be modified post-deployment.