GitOps Codefresh pipeline integration

Use Hosted GitOps with any popular Continuous Integration (CI) solution, not just with Codefresh CI. If you have Hosted or Hybrid GitOps, you can connect your CI pipelines to Hosted GitOps for deployment with image enrichment and reporting.

Connecting your CI 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 Codefresh pipeline and how to configure the integration, see CI Integrations.

Example of Codefresh pipeline with report image step

version: "1.0"
stages:
  - "clone"
  - "build"
  - "report"

steps:
  clone:
    title: "Cloning repository"
    type: "git-clone"
    repo: "${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}"
    revision: "${{CF_BRANCH}}"
    stage: "clone"
    
  build:
    title: "Building Docker image"
    type: "build"
    image_name: "${{CF_REPO_OWNER}}/color"
    working_directory: "${{clone}}"
    tag: "${{CF_SHORT_REVISION}}"
    dockerfile: "Dockerfile"
    registry: docker-lr
    stage: "build"

  ReportImageMetadataAll:
    title: Report image to Codefresh CD
    type: codefresh-report-image:1.0.10
    working_directory: /code
    stage: "report"
    arguments:
      CF_API_KEY: '${{CF_API_KEY}}'
      CF_IMAGE: 'docker.io/${{CF_REPO_OWNER}}/color:${{CF_SHORT_REVISION}}'
      CF_CONTAINER_REGISTRY_INTEGRATION: docker
      CF_RUNTIME_NAME: "codefresh-hosted"
      CF_GITHUB_TOKEN: '${{GITHUB_TOKEN}}'
      CF_GIT_PROVIDER: github
      CF_GIT_REPO: '${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}'
      CF_GIT_BRANCH: '${{CF_BRANCH}}'
      CF_ISSUE_TRACKING_INTEGRATION: jira
      CF_JIRA_MESSAGE: "${{CF_COMMIT_MESSAGE}}"
      CF_JIRA_PROJECT_PREFIX: CR

Codefresh pipeline-GitOps integration settings

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

For the complete argument reference, see CI integration for GitOps argument reference.

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

Templatization examples for CF arguments

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

Codefresh pipelines have system variables you can use to templatize argument values.

CF_IMAGE examples

Example: Report full repo and branch information

This example illustrates how to define the value for CF_IMAGE to report the repo owner, name, and branch, with the Git hash.

Value:
${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}:${{CF_BRANCH_TAG_NORMALIZED}}-${{CF_SHORT_REVISION}}

where:

• ${{CF_REPO_OWNER}} reports the owner of the repository. For example, nr-codefresh.
• ${{CF_REPO_NAME}} reports the name of the repository. For example, codefresh-production.
• ${{CF_BRANCH_TAG_NORMALIZED}} reports the normalized version of the branch name, without invalid characters in case the branch name is the Docker image tag name. For example, pr-2345, new-auth-strategy (branch names without normalization required), and gcr.io/codefresh-inc/codefresh-io/argo-platform-audit.1.1909.0 (normalized version of original branch name gcr.io/codefresh-inc/codefresh-io/argo-platform-audit:1.1909.0).
• ${{CF_SHORT_REVISION}} reports the abbreviated 7-character revision hash, as used in Git. For example, 40659e7.

Example: Report a specific image tag

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

Value:
{{CF_REPO_OWNER}}/${{CF_REPO_NAME}}:<v1.0>

where:

• ${{CF_REPO_OWNER}} and ${{CF_REPO_NAME}} report the names of the repository owner 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/${{CF_REPO_NAME}}:latest

where:

• codefresh is the hard-coded owner of the image.
• ${{CF_REPO_NAME}} reports the name of the repository that triggered the pipeline. For example, codefresh-production.
• latest reports the latest Git tag available for the repository defined by ${{CF_REPO_NAME}}. For example, v1.0.4-14-g2414721.

CF_GIT_BRANCH examples

Example: Report Git branch or tag with committer and commit message

This example illustrates how to report the name or tag of the Git branch with committer and commit message.

Value:
${{CF_REPO_NAME}}/${{CF_BRANCH}}:${{CF_COMMIT_AUTHOR}}/${{CF_COMMIT_MESSAGE}}

where:

• ${{CF_REPO_NAME}} reports the name of the repository. For example, codefresh-production.
• ${{CF_BRANCH}} reports the branch name or tag based on the JSON payload of the Git repository that triggered the pipeline. For example, new-auth-strategy.
• ${{CF_COMMIT_AUTHOR}} reports the name of the user who made the commit. For example, cf-support.
• ${{CF_COMMIT_MESSAGE}} reports the commit message of the repository. For example, support oauth authentication for ci integrations.

Example: Report normalized Git branch or tag with committer and commit message

This example illustrates how to report the normalized name or tag of the Git branch with committer and commit message.
Normalizing the branch name removes any invalid characters in the name if the branch name is also used as the Docker image tag name.

Value:

${{CF_REPO_NAME}}/${{CF_BRANCH_TAG_NORMALIZED}}:${{CF_COMMIT_AUTHOR}}/${{CF_COMMIT_MESSAGE}}

where:

• ${{CF_REPO_NAME}} reports the name of the repository. For example, codefresh-production.
• ${{CF_BRANCH_TAG_NORMALIZED}} reports the normalized version of the branch name or tag based on the JSON payload of the Git repository that triggered the pipeline.
• ${{CF_COMMIT_AUTHOR}} reports the name of the user who made the commit. For example, nr-codefresh.
• ${{CF_COMMIT_MESSAGE}}reports the commit message of the repository. For example, support oauth authentication for ci integrations.

Example: Report normalized Git branch or tag in lowercase with PR information

This example illustrates how to report the normalized name or tag of the Git branch in lowercase, with PR (pull request) information.
Normalizing the branch name removes any invalid characters in the name if the branch name is also used as the Docker image tag name.

Value:
${{CF_REPO_NAME}}/${{CF_BRANCH_TAG_NORMALIZED}}:${{CF_PULL_REQUEST_TARGET}}/${{CF_PULL_REQUEST_NUMBER}}

where:

• ${{CF_REPO_NAME}} reports the name of the repository. For example, production.
• ${{CF_BRANCH_TAG_NORMALIZED}} reports the normalized version of the branch name or tag based on the JSON payload of the Git repository that triggered the pipeline. For example, pr-2345, new-auth-strategy (branch names without normalization required), and gcr.io/codefresh-inc/codefresh-io/argo-platform-audit.1.1909.0 (normalized version of original branch name gcr.io/codefresh-inc/codefresh-io/argo-platform-audit:1.1909.0).
• ${{CF_PULL_REQUEST_TARGET}} reports the target branch of the PR. For example, new-auth-strategy.
• ${{CF_PULL_REQUEST_NUMBER}} reports the number of the PR. For example, #323.

CF_JIRA_MESSAGE examples

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

Value:
CR-1246

Codefresh pipeline integration logs

View and analyze logs for Codefresh pipelines through the Logs tab. When a Codefresh 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 for the pipeline, and view the Codefresh report image step

Build in Codefresh

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

Here is an example of the pipeline build in Codefresh with the Enrich image for GitOps step (top) and the log (down).

Related articles

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