Skip to main content

Check out Port for yourself ➜ 

Jenkins

Loading version...

Port's Jenkins integration allows you to model Jenkins resources in your software catalog and ingest data into them.

Supported resources JobBuildUserStage

Prerequisites​

  • Jenkins API token — In Jenkins, click your username and navigate to Configure > API Token to generate a token to use as the JENKINS_TOKEN.

  • Required plugins — Install the following via Manage Jenkins > Plugins:

Setup​

Choose your preferred installation method below. Not sure which to pick? See the installation methods overview.

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Default mapping configuration​

This is the default mapping configuration for this integration:

Default mapping configuration (click to expand)
createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: job
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .url | split("://")[1] | sub("^.*?/"; "") | gsub("%20"; "-") | gsub("%252F"; "-") | gsub("/"; "-") | .[:-1]
          title: .fullName
          blueprint: '"jenkinsJob"'
          properties:
            jobName: .name
            url: .url
            jobStatus: '{"notbuilt": "created", "blue": "passing", "red": "failing"}[.color]'
            timestamp: .time
            parentJob: .__parentJob


  - kind: build
    selector:
      query: 'true'
      maxBuildsPerJob: 100
    port:
      entity:
        mappings:
          identifier: >-
            .url | split("://")[1] | sub("^.*?/"; "") | gsub("%20"; "-") | gsub("%252F"; "-") | gsub("/"; "-") | .[:-1]
          title: .displayName
          blueprint: '"jenkinsBuild"'
          properties:
            buildStatus: .result
            buildUrl: .url
            buildDuration: .duration
            timestamp: .timestamp / 1000 | todate
          relations:
            parentJob: .url | split("://")[1] | sub("^.*?/"; "") | gsub("%20"; "-") | gsub("%252F"; "-") | gsub("/"; "-") | .[:-1] | gsub("-[0-9]+$"; "")
            previousBuild: >-
              if .previousBuild then (.previousBuild.url | split("://")[1] |
              sub("^.*?/"; "") | gsub("%20"; "-") | gsub("%252F"; "-") |
              gsub("/"; "-") | .[:-1]) else null end

  - kind: user
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .user.id
          title: .user.fullName
          blueprint: '"jenkinsUser"'
          properties:
            url: .user.absoluteUrl
            lastUpdateTime: if .lastChange then (.lastChange/1000) else now end | strftime("%Y-%m-%dT%H:%M:%SZ")

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Mapping & examples per resource​

Use the explorer below to view sample payloads and the resulting Port entities for each resource type.