Promotion rules
Promoting objects from a source to a target environment follows pre-configured rules.
Personal workspaces cannot be promoted.
If you are promoting objects that contain webhooks, ensure that the source and target environment names do not contain any special characters, only alphanumeric characters and underscores.
The following lists explain the promotion rules by object type.
Job artifact and task
-
The Jobs artifact or task is created when it does not exist in the target environment.
- If the target environment name is the same as a context environment in Talend Studio, the artifact or task is created with context parameter values of the design pulled from Talend Studio.
- The target task has the same tags as the source task.
- If the source task uses the option to automatically update to the latest version of its artifact, it is not enabled in the target task.
-
The Job artifact or task is updated when it exists in the target environment.
- Existing parameter values remain unchanged. If a new version of the artifact or task has new parameters, they are added to Parameters.
- If the target environment name is the same as a context environment in Talend Studio, the values for the new parameters are pulled from Talend Studio. Otherwise, they correspond to the values set in the source environment.
- The target task is updated with the tags of the source task.
- For an artifact promotion, tasks do not use promoted artifacts even if they are set to use the latest artifact version, because this latest artifact version only refers to versions of the published artifact. You need to test the promoted artifact before eventually publishing this artifact for your tasks to use it.
- If the target task uses a specific version of the artifact, it keeps using this version and the option to automatically update it is not selected. If the target task uses the option to automatically update the artifact version, the version is updated to the one used by the source task and the option remains enabled.
For this reason, when a promoted task is created in the target environment for the first time, the auto-update option, Always use the latest available artifact version, is automatically deactivated.
This ensures that your task is not inadvertently updated to a new artifact version before you have a chance to review and test the promoted task and confirm the correct artifact version to be used.
Pipeline artifact and task
-
The pipeline artifact or task is created when it does not exist in the target environment.
- The target task has the same tags as the source task.
- If the source task uses the option to automatically update to the latest version of its artifact, it is not enabled in the target task.
-
The pipeline artifact or task is updated when it exists in the target environment.
- Existing parameter values remain unchanged.
- The target task is updated with the tags of the source task.
- If the target task uses a specific version of the artifact, it keeps using this version and the option to automatically update it is not selected. If the target task uses the option to automatically update the artifact version, the version is updated to one used by the source task and the option remains enabled.
Plan
- The plan is created when it does not exist in the target environment.
- The plan is updated when it exists in the target environment.
Connection
- The connection is created with the same name and type when it does not exist in the target environment.
-
The connection is updated with the same name and type when it exists in the target environment.
- Parameters are unchanged.
- If a connection with the same name but different type exists in the target environment, the promotion analysis displays an error. The promotion report displays an error and the task is not promoted.
- For security reason, values of the secured parameters are reset to <change me> in the target environment. You need to manually enter them again.
Resource
- The resource is created when it does not exist in the target environment.
- The resource is overwritten (Override) with the values from the source environment or ignored (Keep target), when it exists in the target environment.
Task scheduler
- The task scheduler is created when it does not exist in the target environment.
- The task scheduler is updated when it exists in the target environment.
Workspace
- The workspace is created with empty roles when it does not exist in the target
environment.
Administrators must create roles in the target environment.
- The workspace is updated when it exists in the target environment.
The objects in the workspace are updated according to the promotion rules specific to each object type.
Remote Engine or Remote Engine Gen2 part of the task/workspace/environment promoted
- Remote Engine or Remote Engine Gen2 is
created when it does not exist in the target environment.
New Remote Engines must be paired after promotion.
- Remote Engine or Remote Engine Gen2 is updated when it exists in the target environment.
Remote Engine cluster
- Remote Engine cluster is created when it does not exist in the target environment.
Remote Engines are not promoted/created during the cluster promotion. They must be added to the promoted cluster in the target environment.
- Remote Engine cluster is reused when it exists in the target environment.
Run profile
- The run profile is created when it does not exist in the target environment.
- The run profile is overwritten (Override) with the values from the source environment or ignored (Keep target), when it exists in the target environment.