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

        Issue Links

          Activity

            allan_burdajewicz Allan BURDAJEWICZ created issue -
            allan_burdajewicz Allan BURDAJEWICZ made changes -
            Field Original Value New Value
            Description When creating a new job from the REST API using an XML file:

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

            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.

            h3. Impact

            The absence of the {{legacyIds}} file cause the {{RunIdMigrator}} to "migrate" that job on the next startup. 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.

            h3. Workaround

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

            {code}
            # 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"
            {code}

            h3. Further Note

            The "RunIdMigrator" is instantiated in {{Job}} and {{AbstractProject}} when the [Item#onCreatedFromScratch|https://github.com/jenkinsci/jenkins/blob/jenkins-2.269/core/src/main/java/hudson/model/Item.java#L228-L236] is called. But this is not called when using the REST API to copy a job or to create an item from XML:

            * https://github.com/jenkinsci/jenkins/blob/jenkins-2.269/core/src/main/java/hudson/model/ItemGroupMixIn.java#L219-L261
            * https://github.com/jenkinsci/jenkins/blob/jenkins-2.269/core/src/main/java/hudson/model/ItemGroupMixIn.java#L263-L306
            When creating a new job from the REST API using an XML file:

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

            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.

            h3. Impact

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

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

            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.

            h3. Workaround

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

            {code}
            # 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"
            {code}

            h3. Further Note

            The "RunIdMigrator" is instantiated in {{Job}} and {{AbstractProject}} when the [Item#onCreatedFromScratch|https://github.com/jenkinsci/jenkins/blob/jenkins-2.269/core/src/main/java/hudson/model/Item.java#L228-L236] is called. But this is not called when using the REST API to copy a job or to create an item from XML:

            * https://github.com/jenkinsci/jenkins/blob/jenkins-2.269/core/src/main/java/hudson/model/ItemGroupMixIn.java#L219-L261
            * https://github.com/jenkinsci/jenkins/blob/jenkins-2.269/core/src/main/java/hudson/model/ItemGroupMixIn.java#L263-L306
            allan_burdajewicz Allan BURDAJEWICZ made changes -
            Summary legacyIds missing when creating job via REST API legacyIds missing when creating jobs via REST API or CLI
            dbradley771 David C. Bradley made changes -
            Link This issue causes JENKINS-59402 [ JENKINS-59402 ]
            dbradley771 David C. Bradley added a comment - For documentation, here's a CloudBees article related to this issue: https://docs.cloudbees.com/docs/cloudbees-ci-kb/latest/client-and-managed-masters/jenkins-startup-logs-show-runidmigrator-logs

            People

              Unassigned Unassigned
              allan_burdajewicz Allan BURDAJEWICZ
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated: