Running the Jenkins pipeline using parameters adapted to your environment - 8.0

Talend Software Development Life Cycle Best Practices Guide
Version
8.0
Language
English
Product
Talend Big Data
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Module
Talend Administration Center
Talend Artifact Repository
Talend CommandLine
Talend JobServer
Talend Studio
Content
Administration and Monitoring
Deployment
Design and Development

Configure the pipeline script provided by Talend to generate the project items according to the Maven phase you want to achieve and the repository you want to deploy your artifacts to.

Some parameters come from the maven_settings file you have previously defined and the credentials you have stored in Jenkins. For more information about the Talend Maven parameters you can use when configuring your pipeline, see Talend custom Maven build options.

Procedure

  1. From the Jenkins home page, select TalendSimplePipeline.
  2. Click Build with Parameters on the left panel to open the pipeline configuration page.
  3. Set your own values for the environment variables defined in the script (Git project name and branch, Job name/version/type, Maven goals, repository URL, etc.).
    Tip:
    • You can copy-paste the parameters that are stated in the description of each field in the corresponding parameter fields.
    • You can also directly look for the <> references in the jenkins_talend_helper.groovy script provided by Talend as an example and replace them with values corresponding to your environment. The script can be found in the Downloads tab of this page on Talend Help Center.

    Example

    Values for a project named CICD, Jobs named my_simple_job, my_complex_job and my_other_complex_job with a 0.1 version to be deployed in a Docker image named cicd4talend:
    Parameter Example of default value
    GIT_PROJECT_LIST 
    CICD;https://github.com/talenduser/CICD.git;main
    JOBS_TO_BUILD 
    jobs/process/my_simple_job_0.1,jobs/process/my_complex_job_0.1,jobs/process/my_other_complex_job_0.1
    MVN_GOALS 
    clean deploy -Pdocker
    TALEND_CI_RUN_CONFIG 
    -Dlicense.path=license 
-Dtalend.studio.p2.base=https://update.talend.com/Studio/8/base
-Dtalend.studio.p2.update=https://update.talend.com/Studio/8/updates/latest
-Dorg.slf4j.simpleLogger.showDateTime=true 
-Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss,SSS
    Note:
    • Talend recommends using the -Dtalend.studio.p2.update parameter in order to automatically download and install Talend CommandLine at build time or to use the local generation type.
    • Talend does not recommend running more than one Talend CommandLine at any given time on a machine. The easiest way to prevent this is to limit the number of executors on the servers to 1.
    TALEND_CI_BUILD_OPTIONS 
    -Dtalend.docker.name=cicd4talend 
-Djkube.docker.push.registry=talenddockerregistry 
-Djkube.docker.username=talenduser 
-Djkube.docker.password=Talenddock3rpassw0rd
    Warning: Syntax requirements:
    • The value of the GIT_PROJECT_LIST parameter must be in upper case otherwise it might cause build failure. If you used special characters in the project name or have any doubts on its final syntax you can check it in the parent pom.xml file of your project (talend.project.name variable in <project>/poms/pom.xml).
    • The value of the JOBS_TO_BUILD parameter must be in lower case even if the original name of your Job/Route/Service contained upper case as all artifacts are in lower case in the .pom files required to launch the build.
    • Do not add manually the "-SNAPSHOT" suffix to the version value. Snapshots and releases are decoupled from the version itself and must only be handled via the Studio preferences, see Changing the deployment version of each artifact at once.
  4. Click Build to take your changes into account and build your artifacts.