GitOps Jenkins integration

Use Hosted GitOps with any popular Continuous Integration (CI) solution, not just with Codefresh CI. Jenkins is one of the third-party CI platform/tools that you can connect to Codefresh for deployment with image enrichment and reporting.

Connecting a Jenkins pipeline, adds the CI information to images which are displayed in the Images dashboard, as in the example below.

For information on how to use the image reporting action in your Jenkins pipeline and how to configure the integration, see CI Integrations.

Example of Jenkins pipeline with report image step

pipeline {
    
    agent any
    stages {
        stage('Clone repository') {               
            steps {
                checkout scm 
            }
        }
        stage ('Build & Push ') {
            environment {
                CF_IMAGE= credentials('CF_IMAGE')
            }
            steps {
                sh 'echo "Building $CF_IMAGE"'
                script {
                    def app
                    app = docker.build("${env.CF_IMAGE}")
                    // require credentials to be stored under DOCKERHUB
                    docker.withRegistry('https://registry.hub.docker.com', 'DOCKERHUB') {   
                            app.push("latest")        
                    }
                }
                sh '''
                    # test we have image in repository.
                    docker pull $CF_IMAGE
                    '''
            }
        }
        
        stage('report image') {
            environment {
                // Name of runtime to implement the enrichment
                CF_RUNTIME_NAME= 'codefresh-hosted'

                // Image path to enrich
                CF_IMAGE= credentials('CF_IMAGE')

                // Codefresh API key !! Committing a plain text token is a security risk. We highly recommend using encrypted secrets. !!
                // Documentation - https://www.jenkins.io/doc/book/using/using-credentials
                CF_API_KEY= credentials('CF_API_KEY')

                // Name of Container registry integration
                CF_CONTAINER_REGISTRY_INTEGRATION= 'docker'
                
                // Name of Jira integration
                CF_ISSUE_TRACKING_INTEGRATION= 'jira'
                
                // String starting with the issue ID to associate with image
                CF_JIRA_MESSAGE= 'CR-11027'
                
                // Jira project filter
                CF_JIRA_PROJECT_PREFIX= 'CR'

                // GitHub Access token !! Committing a plain text token is a security risk. We highly recommend using encrypted secrets. !!
                // Documentation - https://www.jenkins.io/doc/book/using/using-credentials
                CF_GITHUB_TOKEN= credentials('CF_GITHUB_TOKEN')
            }
            steps {
                sh '''
                    export CF_CI_TYPE="jenkins"
                    # add workflow details
                    export CF_WORKFLOW_NAME="${CF_WORKFLOW_NAME:-$JOB_NAME}"
                    export CF_WORKFLOW_URL="${CF_WORKFLOW_URL:-$BUILD_URL}"
                    # add git branch
                    export CF_GIT_PROVIDER="${CF_GIT_PROVIDER:-github}"
                    WITHOUT_POSTFIX="${GIT_URL%.*}"
                    export CF_GIT_REPO="${CF_GIT_REPO:-${WITHOUT_POSTFIX#*//*/}}"
                    # slice branch name from repo/branch
                    export CF_GIT_BRANCH="${CF_GIT_BRANCH:-${GIT_BRANCH#*/}}"
                    env | cut -f 1 -d "=" | grep -E "^CF_"  > cf_env
                    docker run --env-file=cf_env "quay.io/codefresh/codefresh-report-image:latest"
                '''
            }
        }
        
    }
}

Jenkins-GitOps integration settings

The table describes the arguments to connect Codefresh pipelines to Codefresh GitOps.

For how-to instructions, see Connect a third-party CI platform/tool to Codefresh.

Templatization examples for CF arguments

Arguments such as CF_IMAGE, CF_GIT_BRANCH, and CF_JIRA_MESSAGE are populated dynamically when the Jenkins pipeline is triggered. You can templatize the values of these arguments in the pipeline to ensure that the required information is included in the reported image.

Jenkins offers a Git plugin with environment variables you can use to templatize argument values.

CF_IMAGE

Example: Report repo, branch with Git hash

This example illustrates how to define the value for CF_IMAGE to report Git repo, branch, committer, and Git hash information.

Value:
${env.GIT_COMMITTER_NAME}/${env.GIT_URL}/${env.GIT_BRANCH}/${env.GIT_REVISION}

where:

• ${env.GIT_COMMITTER_NAME} reports the name of the user who made the commit. For example, nr-codefresh.
• ${env.GIT_URL} reports the name of the Git repository. For example, codefresh-production.
• ${env.GIT_BRANCH} reports the name of the Git branch. For example, pr-2345, new-auth-strategy.
• ${env.GIT_REVISION} reports the Git SHA1 commit ID pointing to the commit that was built. For example, fa53bfa91df14c4c9f46e628a65ee21dd574490a.

Example: Report a specific image tag

This example illustrates how to define the value for CF_IMAGE when you know the specific image version you want to report.

Value:
${env.GIT_COMMITTER_NAME}/${env.GIT_URL}/<v1.0>

where:

• ${env.GIT_COMMITTER_NAME} and ${env.GIT_URL} report the names of the user hwo made the commit and the repository, respectively. For example, nr-codefresh and codefresh-production, respectively.
• <v1.0> reports the hard-coded tag v1.0.

Example: Report the latest Git tag available on repository

This example illustrates how to define the value for CF_IMAGE value to report the latest Git tag on the repository.

Value:
codefresh/${env.GIT_URL}/latest

where:

• codefresh is the hard-coded re
• ${env.GIT_URL} reports the name of the repository that triggered the integration.
• latest reports the latest Git tag available for the repository defined by ${env.GIT_URL}. For example, v1.0.4-14-g2414721.

CF_GIT_BRANCH

Example: Report the fully-formed Git branch

This example illustrates how to define the value for CF_GIT_BRANCH value to report the fully-formed Git branch.

Value:
${env.GIT_URL}/${env.GIT_BRANCH}

where:

• ${env.GIT_URL} is the name of the repository that triggered the pipeline. For example, codefresh-production.
• ${env.GIT_BRANCH} is the fully-formed name of the Git branch. For example, origin/auth-feature-branch.

Example: Report the local Git branch

This example illustrates how to define the value for CF_GIT_BRANCH value to report only the branch in the repository that triggerred the pipeline.

Value:
${env.GIT_URL}/${env.GIT_LOCAL_BRANCH}

where:

• ${env.GIT_URL} is the name of the repository that triggered the piepline.
• ${env.GIT_LOCAL_BRANCH} is the name of the Git branch. For example, auth-feature-branch.

CF_JIRA_MESSAGE

The Jira message represents an existing Jira issue, and must be a literal string.

Value:
CR-1246

Jenkins integration logs

View and analyze logs for Jenkins through the Logs tab. When a Jenkins pipeline is run, it is added to the Logs tab.
You can:

• Filter by status or by date range to view a subset of actions
• Navigate to the build file in Jenkins, and view the Codefresh report image step.

Build in Jenkins

The Run column includes the link to the pipeline in Jenkins.

Here is an example of the Jenkins log for the pipeline with the report image step.

Related articles

Shared Configuration Repository
Image enrichment with GitOps integrations
Container registry GitOps integrations
Issue-tracking GitOps integrations