Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit9cbb8e3

Browse files
authored
Cf ci integration fixes (#261)
* Update CI integration topicsUpdated params list and procedure; restructured acc to feedback* Update ci-integrations.md* Update ci integration topics* Updates* Update github-actions.mdFixed Git repo description* Update github-actions.md
1 parent437c7b2 commit9cbb8e3

File tree

8 files changed

+317
-263
lines changed

8 files changed

+317
-263
lines changed

‎_docs/integrations/ci-integrations.md‎

Lines changed: 36 additions & 20 deletions
Large diffs are not rendered by default.

‎_docs/integrations/ci-integrations/codefresh-classic.md‎

Lines changed: 72 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,95 @@ sub_group: ci-integrations
66
toc:true
77
---
88

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

11-
10+
Use Hosted GitOps with any popular Continuous Integration (CI) solution, not just with Codefresh CI. Codefresh Classic is one of the third-party CI platform/tools that you can connect to Codefresh for deployment with image enrichment and reporting.
11+
12+
13+
Connecting Codefresh Classic, adds the CI information to images which are displayed in the Images dashboard, as in the example below.
14+
15+
{% include
16+
image.html
17+
lightbox="true"
18+
file="/images/integrations/images-dashboard.png"
19+
url="/images/integrations/images-dashboard.png"
20+
alt="Images dashboard with enriched image information"
21+
caption="Images dashboard with enriched image information"
22+
max-width="70%"
23+
%}
24+
25+
1226

1327
For information on how to use the image reporting action in your Codefresh Classic pipeline and how to configure the integration, see[CI Integrations]({{site.baseurl}}/docs/integrations/ci-integrations/).
1428

1529

30+
###Example of Codefresh Classic pipeline with report image step
31+
32+
{% highlight yaml %}
33+
{% raw %}
34+
35+
reportImage:
36+
title: Report image to Codefresh CD
37+
type: codefresh-report-image
38+
working_directory: /code
39+
arguments:
40+
# The URL to the cluster with the Codefresh runtime to integrate with.
41+
CF_HOST: '[runtime-host-url]'
42+
43+
# Codefresh API key !! Committing a plain text token is a security risk. We highly recommend using encrypted secrets !!
44+
# Documentation - https://codefresh.io/docs/docs/configure-ci-cd-pipeline/secrets-store/
45+
CF_API_KEY: ${{API_KEY}}
46+
47+
# Image path to enrich
48+
CF_IMAGE: '[full image path here, including tag]'
49+
50+
# Name of Container registry integration
51+
CF_CONTAINER_REGISTRY_INTEGRATION: 'v2'
52+
53+
# The git branch which is related for the commit
54+
CF_GIT_BRANCH: '[name-of-your-git-branch]'
55+
56+
# Name of Jira integration
57+
CF_JIRA_INTEGRATION: 'jira'
58+
59+
# Jira project filter
60+
CF_JIRA_PROJECT_PREFIX: '[jira-project-prefix]'
61+
62+
# String starting with the issue ID to associate with image
63+
CF_JIRA_MESSAGE: '[issue-id]'
64+
65+
{% endraw %}
66+
{% endhighlight yaml %}
67+
1668
###Codefresh Classic-Codefresh integration arguments
17-
The table describes the arguments required to connect Codefresh Classic to Codefresh.
69+
The table describes the arguments required to connect Codefresh Classic to Codefresh.
70+
71+
>Except for Git branch and Git repo which are required, you can omit other Git provider arguments. Codefresh retrieves the required values from the runtime context selected for the integration.
72+
73+
For the complete argument reference, see[CI integration argument reference]({{site.baseurl}}/docs/integrations/ci-integrations/#ci-integration-argument-reference).
74+
1875

1976
{: .table .table-bordered .table-hover}
2077
| Argument| Description| Required/Optional/Default|
2178
| ----------| --------| -------------------------|
2279
|`CF_RUNTIME_NAME`| The runtime to use for the integration. If you have more than one runtime, select the runtime from the list.| Required|
80+
|`CF_PLATFORM_URL`| The root URL of the Codefresh application. The default value is`https://g.codefresh.io`.| Optional|
2381
|`CF_API_KEY`| The API key to authenticate the Codefresh Classic user to Codefresh. Generate the key for the integration.| Required|
2482
|`CF_CONTAINER_REGISTRY_INTEGRATION`| The name of the container registry integration created in Codefresh where the image is stored. To create a container registry integration if you don't have one, click**Create Container Registry Integration**, and then configure the settings. See[Container registry integrations]({{site.baseurl}}/docs/integrations/container-registries/).| Optional|
25-
|`CF_JIRA_INTEGRATION`| The name of the issue tracking integration created in Codefresh to use to enrich the image. Relevant only if Jira enrichment is required for the image. If you don't have a Jira integration, click**Create Atlassian Jira Integration** and configure settings. See[Jira integration]({{site.baseurl}}/docs/integrations/issue-tracking/jira/).| Optional|
83+
|`CF_JIRA_INTEGRATION` | Deprecated from version 0.0.565. Replaced by`CF_ISSUE_TRACKING_INTEGRATION`. |_Deprecated_
84+
|`CF_ISSUE_TRACKING_INTEGRATION`| The name of the issue tracking integration created in Codefresh to use to enrich the image. Relevant only if Jira enrichment is required for the image. If you don't have a Jira integration, click**Create Atlassian Jira Integration** and configure settings. See[Jira integration]({{site.baseurl}}/docs/integrations/issue-tracking/jira/).| Optional|
2685
|`CF_IMAGE`| The image to be enriched and reported in Codefresh. Pass the`[account-name]/[image-name]:[tag]` built in your CI.| Required|
2786
|`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|
2887
|`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|
2988
|`CF_GIT_REPO`| The Git repository with the configuration and code used to build the image.| Required|
30-
|`CF_GIT_PROVIDER`| The Git provider for the integration, and can be either GitHub, GitLab, or Bitbucket.| Required|
31-
|`CF_GITHUB_TOKEN`| The GitHub authentication token. The token must have`repo` scope. See[Git tokens]({{site.baseurl}}/docs/reference/git-tokens/).| Required|
32-
|`CF_GITHUB_API_URL`| The URL totheGitHub developer site.| Required|
33-
|`CF_BITBUCKET_USERNAME`| The username for the Bitbucket or theBitBucket Server (on-prem) account.|Required|
34-
|`CF_BITBUCKET_PASSWORD`| The password for the Bitbucket or theBitBucket Server (on-prem) account.|Required|
35-
|`CF_BITBUCKET_HOST_URL`| Relevant for Bitbucket Server accounts only. The URL address of your Bitbucket Server instance. Example,`https://bitbucket-server:7990`.| Required|
36-
|`CF_JIRA_PROJECT_PREFIX`| Relevant only when`CF_JIRA_INTEGRATION` is defined. The Jira project prefix that identifies the ticket number to use.| Required|
37-
|`CF_JIRA_MESSAGE`| Relevant only when`CF_JIRA_INTEGRATION` is defined. The Jira issue IDs matching the string to associate with the image.| Required|
38-
|`CF_JIRA_FAIL_ON_NOT_FOUND`| Relevant only when`CF_JIRA_INTEGRATION` is defined. The report image action when the`CF_JIRA_MESSAGE` is not found. When set to`true`, the report image action is failed.| Required|
89+
| `CF_GIT_PROVIDER` | The Git provider for the integration, and can be either `github`, `gitlab`, or `bitbucket`. {::nomarkdown} <ul><li>Optional when you don't define other related Git provider arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Git provider arguments. For example, when you define <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">CF_GITLAB_TOKEN</span>, then you <i>must</i> define all Git provider arguments, in this case, <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">CF_GIT_PROVIDER</span> as <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">gitlab</span>, and <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">CF_GITLAB_HOST_URL</span>.</li><ul>{:/}| Optional |
90+
|`CF_GITLAB_TOKEN`| The token to authenticate the GitLab account. {::nomarkdown} <ul><li>Optional when you don't define any GitLab-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the GitLab-specific arguments, such as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_GIT_PROVIDER</span> as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">gitlab</span>, or <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_GITLAB_HOST_URL</span>.</li><ul>{:/}| Optional|
91+
|`CF_GITLAB_HOST_URL`| The URL address of your GitLab Cloud/Server instance. {::nomarkdown} <ul><li>Optional when you don't define other related GitLab-specific arguments. When not defined, Codefresh retrievestherequired information from the runtime selected for the integration. <li>Required when you define at least one of the GitLab-specific arguments, such as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_GIT_PROVIDER</span> as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">gitlab</span>, or <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_GITLAB_TOKEN</span>.</li><ul>{:/}| Optional|
92+
|`CF_BITBUCKET_USERNAME`| The username for the Bitbucket or theBitbucket Server (on-prem) account.{::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_GIT_PROVIDER</span> as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">bitbucket</span>, <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_BITBUCKET_PASSWORD</span> or <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_BITBUCKET_HOST_URL</span>.</li><ul>{:/}| Optional|
93+
|`CF_BITBUCKET_PASSWORD`| The password for the Bitbucket or theBitbucket Server (on-prem) account.{::nomarkdown} <ul><li>Optional when you don't define other related Bitbucket-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration. <li>Required when you define at least one of the Bitbucket-specific arguments, such as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_GIT_PROVIDER</span> as <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">bitbucket</span>, <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_BITBUCKET_USERNAME</span>, or <spanstyle="font-family:var(--font-family-monospace);font-size:87.5%;color:#ad6800;background-color:#fffbe6">CF_BITBUCKET_HOST_URL</span>.</li><ul>{:/}| Optional|
94+
| `CF_BITBUCKET_HOST_URL` | Relevant for Bitbucket Server accounts only. The URL address of your Bitbucket Server instance. Example, `https://bitbucket-server:7990`. {::nomarkdown}<ul><li>Optional when you don't define other related Bitbucket Server-specific arguments. When not defined, Codefresh retrieves the required information from the runtime selected for the integration.</li><li>Required when you define at least one of the Bitbucket Server-specific arguments, such as <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">CF_GIT_PROVIDER</span> as <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">bitbucket</span>, <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">CF_BITBUCKET_USERNAME</span> or <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">CF_BITBUCKET_PASSWORD</span>.</li></ul>{:/} | Optional |
95+
|`CF_JIRA_PROJECT_PREFIX`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The Jira project prefix that identifies the ticket number to use.| Required|
96+
|`CF_JIRA_MESSAGE`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The Jira issue IDs matching the string to associate with the image.| Required|
97+
|`CF_JIRA_FAIL_ON_NOT_FOUND`| Relevant only when`CF_ISSUE_TRACKING_INTEGRATION` is defined. The report image action when the`CF_JIRA_MESSAGE` is not found. When set to`true`, the report image action is failed.| Required|
3998

4099
For how-to instructions, see[Connect a third-party CI platform/tool to Codefresh]({{site.baseurl}}/docs/integrations/ci-integrations/#connect-a-third-party-ci-platformtool-to-codefresh/).
41100

@@ -142,44 +201,6 @@ The Jira message represents an existing Jira issue, and must be a literal string
142201
Value:
143202
`CR-1246`
144203

145-
###Example of report image step in Codefresh Classic pipeline
146-
147-
{% highlight yaml %}
148-
{% raw %}
149-
150-
reportImage:
151-
title: Report image to Codefresh CD
152-
type: codefresh-report-image
153-
working_directory: /code
154-
arguments:
155-
# The URL to the cluster with the Codefresh runtime to integrate with.
156-
CF_HOST: '[runtime-host-url]'
157-
158-
# Codefresh API key !! Committing a plain text token is a security risk. We highly recommend using encrypted secrets !!
159-
# Documentation - https://codefresh.io/docs/docs/configure-ci-cd-pipeline/secrets-store/
160-
CF_API_KEY: ${{API_KEY}}
161-
162-
# Image path to enrich
163-
CF_IMAGE: '[full image path here, including tag]'
164-
165-
# Name of Container registry integration
166-
CF_CONTAINER_REGISTRY_INTEGRATION: 'v2'
167-
168-
# The git branch which is related for the commit
169-
CF_GIT_BRANCH: '[name-of-your-git-branch]'
170-
171-
# Name of Jira integration
172-
CF_JIRA_INTEGRATION: 'jira'
173-
174-
# Jira project filter
175-
CF_JIRA_PROJECT_PREFIX: '[jira-project-prefix]'
176-
177-
# String starting with the issue ID to associate with image
178-
CF_JIRA_MESSAGE: '[issue-id]'
179-
180-
{% endraw %}
181-
{% endhighlight yaml %}
182-
183204
###Codefresh Classic integration logs
184205
View and analyze logs for Codefresh Classic workflows through the Logs tab. When a Codefresh Classic pipeline is run, it is added to the Logs tab.
185206
You can:

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp