Adding a Dynamic Engine instance and its environment

Add and associate the logical entities of a Dynamic Engine and Dynamic Engine environment to get the manifest files for deployment.

Before you begin

See the prerequisites described at Prerequisites to use Dynamic Engine

Procedure

1. Create a Dynamic Engine environment entity in Talend Management Console by issuing this call:

   Method: POST
   Endpoint: https://api.<ENV>.cloud.talend.com/orchestration/dynamic-engine-environments
   Headers:

   {
     "Content-Type": "application/json",   
     "Authorization": "Bearer <your_personal_access_token>"
   }
   

   Payload:

   {
     "name": "<engine_environment_name>",
     "workspaceName": "<first_workspace_name_in_the_new_environment>"
   }
   

   • You must have the Environment Administrator role in Talend Management Console.
   • Read the ID of this environment in the response and note it down.

2. Create a Dynamic Engine logical entity in Talend Management Console by issuing this call:

   Method: POST
   Endpoint: https://api.<ENV>.cloud.talend.com/processing/runtimes/dynamic-engines
   Headers:

   {
     "Content-Type": "application/json",
     "Authorization": "Bearer <your_personal_access_token>"
   }
   

   Payload:

   {
     "name": "<engine_name>",
     "description": "<a_meaningful_description_of_your_engine>"    
   }
   

   • You must have the TMC_CLUSTER_MANAGEMENT permission.
   • Read the ID of the Dynamic Engine entity and note it down.

3. Assign the environment to the engine by issuing the following call:

   Method: POST
   Endpoint: https://api.<ENV>.cloud.talend.com/orchestration/dynamic-engine-environments/{environmentId}/connection?dynamicEngineId=<engine_id>
   Headers:

   {
     "Authorization": "Bearer <your_personal_access_token>"
   }
   

   • You must have the Engine Manage permission, included in the Infrastructure Administrator role or your custom role.

4. Get the manifest files including the Dynamic Engine and all its associated environments. In this example, only one environment has been associated.

   Method: POST
   Endpoint: https://api.<ENV>.cloud.talend.com/processing/runtimes/dynamic-engines/{dynamicEngineId}/actions/generate-manifest
   Headers:

   {
     "Content-Type": "application/json",
     "Authorization": "Bearer <your_personal_access_token>"
   }
   

   Payload:

   {
     "version": "0.10.0"
   }
   

   • A body, even empty, is required. For example, if you want to use the default Dynamic Engine version without specifying it, put {} in the body.
   • You will receive the manifest zip file in the response.
   • The version of your engine is stored in the Id field in the same response.

5. Apply the manifest files as described in Setting up Dynamic Engines.