GitOps integrations argument reference
Complete reference for arguments supported for integrations with GitOps
CI integrations: Complete argument reference
The table describes all the arguments required for CI integrations in general. The actual arguments required, differs according to the specific CI integration tool.
Argument | Description | Required/Optional/Default |
---|---|---|
CF_HOST |
Deprecated from v 0.0.460 and higher. Recommend using CF_RUNTIME_NAME instead. CF_HOST has been deprecated because the URL is not static, and any change can fail the enrichment.The URL to the cluster with the Codefresh runtime to integrate with. If you have more than one runtime, select the runtime from the list. Codefresh displays the URL of the selected runtime cluster. |
Deprecated |
CF_RUNTIME_NAME |
The runtime to use for the integration. If you have more than one runtime, select the runtime from the list. | Required |
CF_PLATFORM_URL |
The root URL of the Codefresh application. The default value is https://g.codefresh.io . |
Optional |
CF_API_KEY |
The API key for authentication. Generate the key for the integration. | Required |
CF_CONTAINER_REGISTRY_INTEGRATION |
The name of the container registry integration created in Codefresh where the image is stored to reference in the CI pipeline. See Container registry integrations. Alternatively, you can use one of these container registries with explicit credentials:
|
Optional |
CF_DOCKERHUB_USERNAME |
Relevant only to provide explicit credentials to the Docker Hub container registry where the image is stored. The username for the Docker Hub container registry. To use a Docker Hub container registry integration created in Codefresh, set CF_CONTAINER_REGISTRY_INTEGRATION instead. |
Optional |
CF_DOCKERHUB_PASSWORD |
Relevant only if CF_DOCKERHUB_USERNAME is specified.The password for the Docker Hub container registry. |
Optional |
CF_REGISTRY_USERNAME |
Relevant for container registries that support Docker Registry Protocol v2. The username for the Docker Registry Protocol v2 container registry. To use a container registry integration created in Codefresh, set CF_CONTAINER_REGISTRY_INTEGRATION instead. |
Optional |
CF_REGISTRY_PASSWORD |
Relevant only if CF_REGISTRY_USERNAME is specified.The password for the Docker Registry Protocol v2 container registry. |
Optional |
CF_REGISTRY_DOMAIN |
Relevant only if CF_REGISTRY_USERNAME and CF_REGISTRY_PASSWORD are specified. The domain for the Docker Registry Protocol v2 container registry. |
Optional |
CF_GOOGLE_JSON_KEY |
Relevant only for Google Artifact Registry (GAR) or Google Container Registry (GCR). The Google Cloud Platform Service Account key in JSON format to authenticate to GAR or GCR. |
Optional |
CF_GOOGLE_REGISTRY_HOST |
Relevant only if CF_GOOGLE_JSON_KEY is specified.The GAR or GCR host. For example, us-central1-docker.pkg.dev or gcr.io . |
Optional |
CF_IMAGE |
The image to be enriched and reported in Codefresh. Pass the [account-name]/[image-name]:[tag] built in your CI. |
Required |
CF_WORKFLOW_NAME |
The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform. Example, Staging step |
Optional |
CF_GIT_BRANCH |
The Git branch with the commit and PR (pull request) data to add to the image. Pass the Branch from the event payload used to trigger your action. | Required |
CF_GIT_REPO |
The Git repository with the configuration and code used to build the image.
|
Required |
CF_GIT_PROVIDER |
The Git provider for the integration, and can be either github , gitlab , bitbucket , gerrit .
|
Optional |
CF_GITLAB_TOKEN |
The token to authenticate the GitLab account.
|
Optional |
CF_GITLAB_HOST_URL |
The URL address of your GitLab Cloud/Server instance.
|
Optional |
CF_BITBUCKET_USERNAME |
The username for the Bitbucket or the Bitbucket Server (on-prem) account.
|
Optional |
CF_BITBUCKET_PASSWORD |
The password for the Bitbucket or the BitBucket Server (on-prem) account.
|
Optional |
CF_BITBUCKET_HOST_URL |
Relevant only for Bitbucket Server accounts. The URL address of your Bitbucket Server instance. Example, https://bitbucket-server:7990 .
|
Optional |
CF_GERRIT_CHANGE_ID |
Relevant only for Gerrit accounts. The change ID or the commit message containing the Change ID to add to the image. For Gerrit, use this instead of CF_GIT_BRANCH . |
Required |
CF_GERRIT_HOST_URL |
Relevant only for Gerrit accounts. The URL of your website with the Gerrit instance, for example, https://git.company-name.io . |
Required |
CF_GERRIT_USERNAME |
Relevant only for Gerrit accounts. The username for your user account in Gerrit. |
Required |
CF_GERRIT_PASSWORD |
Relevant only for Gerrit accounts. The HTTP password for your user account in Gerrit, to use as the access token to authenticate HTTP requests to Gerrit. |
Required |
CF_JIRA_INTEGRATION |
Deprecated from version 0.0.565 and higher. Replaced by CF_ISSUE_TRACKING_INTEGRATION . |
Deprecated |
CF_ISSUE_TRACKING_INTEGRATION |
The name of the issue tracking integration created in Codefresh for image enrichment. Relevant only if Jira enrichment is required for the image. To create a Jira integration, click Create Atlassian Jira Integration and configure settings. See Jira integration. Required when using API token-based authentication to the Jira server. Leave empty when using CF_JIRA_SERVER_PAT . |
Optional |
CF_JIRA_HOST_URL |
The URL of your Jira instance. For example, https://<company>.atlassian.net . Required when using PAT-based authentication to the Jira server. |
Optional |
CF_JIRA_SERVER_PAT |
The Personal Access Token (PAT) from your Git provider used for authentication to the Jira server, as an alternative to API token-based authentication. When using PAT, configure CF_JIRA_HOST_URL instead of CF_ISSUE_TRACKING_INTEGRATION . |
Optional |
CF_JIRA_PROJECT_PREFIX |
Relevant only when you need a Jira integration with either API or PAT authentication. One or more project prefixes in Jira to identify the Jira ticket number to use. NOTE: Multiple project prefixes require runtime version 0.1.30 or higher. To specify more than one prefix, use a comma-separated list or a regex.
|
Required |
CF_JIRA_MESSAGE |
Relevant only when you need a Jira integration with either API or PAT authentication. The Jira issue IDs matching the string to associate with the image. |
Required |
CF_JIRA_FAIL_ON_NOT_FOUND |
Relevant only when you need a Jira integration with either API or PAT authentication. The report image action when the CF_JIRA_MESSAGE is not found. When set to true , the report image action is failed. |
Required |
Related articles
Image enrichment with GitOps integrations
Container registry GitOps integrations
Issue-tracking GitOps integrations