Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-64356

legacyIds missing when creating jobs via REST API or CLI

    XMLWordPrintable

Details

    • Bug
    • Status: Open (View Workflow)
    • Minor
    • Resolution: Unresolved
    • core
    • None

    Description

      When creating a new job from the REST API using an XML file:

      curl -u <user>:<pass> \
      	 -H "Content-Type:application/xml" \
      	 -X POST http://jenkins.example.com/createItem?name=TEST_JOB \
      	 -d @config.xml
      

      The job is correctly created BUT the builds directory does not contains the legacyIds file. The same happens when using the create-job command with the Jenkins CLI, we see the same behavior.

      When creating a job from the UI however, the legacyIds is correctly added.

      Impact

      The absence of the legacyIds file cause the RunIdMigrator to "migrate" that job on the next startup.

      jenkins.model.RunIdMigrator#migrate: Migrating build records in <pathToJobDirectory>/builds
      

      If many jobs are created using the REST API, this can slow down the next startup considerably. Some users that are automating the creating of items could be impacted.

      Workaround

      Create the job first "from scratch" then update the XML file:

      # create a pipeline job from scratch
      curl -X POST \
      	 -u <user>:<pass> \
      	 -H "Content-Type:application/x-www-form-urlencoded" \
      	 "http://jenkins.example.com/createItem?name=TEST_JOB&mode=org.jenkinsci.plugins.workflow.job.WorkflowJob"
      
      # update the job configuration by providing the XML
      curl -X POST \
      	 -u <user>:<pass> \
      	 -H "Content-Type:application/xml" \
      	 -d @config.xml \
      	 "http://jenkins.example.com/job/TEST_JOB/config.xml"
      

      Further Note

      The "RunIdMigrator" is instantiated in Job and AbstractProject when the Item#onCreatedFromScratch is called. But this is not called when using the REST API to copy a job or to create an item from XML:

      Attachments

        Activity

          There are no comments yet on this issue.

          People

            Unassigned Unassigned
            allan_burdajewicz Allan BURDAJEWICZ
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: