You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,23 @@
1
1
---
2
2
title:"GitOps CI integrations"
3
-
description:""
3
+
description:"Seamlessly integrate existing CI tools with GitOps for image enrichment"
4
4
group:gitops-integrations
5
5
toc:true
6
6
---
7
7
8
-
Use CodefreshHostedGitOps withany popular Continuous Integration (CI) solution, not just with Codefresh CI.
8
+
##Codefresh GitOps withCI solutions
9
9
10
-
You can connect a third-party CI solution to Codefresh, such as GitHub Actions for example, to take care of common CI tasks such as building/testing/scanning source code, and have Codefresh Hosted GitOps still responsible for the deployment, including image enrichment and reporting.
11
-
The integration brings in all the CI information to your images which you can see in the Images dashboard.
10
+
With Codefresh GitOps, you can integrate not only with Codefresh CI but also with other popular Continuous Integration (CI) solutions.
12
11
13
-
See[Image enrichment with GitOps integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/).
12
+
For example, you can connect a third-party CI tool like GitHub Actions to handle common CI tasks, such as building, testing, and scanning source code. Codefresh GitOps can then take care of deployment, image enrichment, and reporting. This integration ensures that all CI-related information is included in the images, which you can view in the Images dashboard.
13
+
14
+
For more details on how it works, see[Image enrichment with GitOps integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/).
14
15
15
16
##Codefresh image reporting and enrichment action
16
-
To support the integrationbetween Codefresh andthird-party CI platforms and tools, wehave createddedicated actions for supported CI tools in the Codefresh Marketplace. These actions combine image enrichment and reporting through integrations with issue tracking and container registry tools.
17
+
To support the integrationwiththird-party CI platforms and tools, weofferdedicated actions in the Codefresh Marketplace. These actions combine image enrichment and reporting through integrations with issue tracking and container registry tools.
17
18
18
19
>**NOTE**
19
-
You can also configurethe integration directly in the Codefresh UI, as described in[Connect a third-party CI platform/tool to Codefresh](#connect-a-third-party-ci-platformtool-to-gitops).
20
+
You can also configurethese integration directly in the Codefresh UI, as described in[Connect a third-party CI platform/tool to Codefresh](#connect-a-third-party-ci-platformtool-to-gitops).
20
21
21
22
22
23
Use the action as follows:
@@ -25,23 +26,23 @@ Use the action as follows:
25
26
1. Use existing CI actions for compiling code, running unit tests, security scanning etc.
26
27
1. Place the final action in the pipeline as the "report image" action provided by Codefresh.
1. When the pipeline completes execution, Codefresh retrieves the information on the image that was built and its metadata through the integration names specified (essentially the same data that Codefresh CI would send automatically).
31
-
1. View the image inCodefresh's[Images dashboard]({{site.baseurl}}/docs/dashboards/images/), and in any[application]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) in which it is used.
32
+
1. View the image inthe[Images dashboard]({{site.baseurl}}/docs/dashboards/images/), and in any[application]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) in which it is used.
32
33
33
34
##Connect a third-party CI platform/tool to GitOps
34
35
Connecting the CI platform/tool to GitOps from the UI includes configuring the required arguments, and then generating and copying the YAML manifest for the report image to your pipeline.
35
36
36
-
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select[**GitOps Integrations**](https://g.codefresh.io/2.0/account-settings/integrations){:target="\_blank"}.
37
-
1. Filter by**CI tools**,thenselect the CI tool and click**Add**.
37
+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select**GitOps Integrations**.
38
+
1. Filter by**CI tools**, select the CI tool, and then click**Add**.
For the complete list of arguments you can use, see[CI integrations argument reference]({{site.baseurl}}/docs/gitops-integrations/ci-integrations/ci-argument-reference/).
45
+
For the complete list of arguments you can use, see[GitOps integrations argument reference]({{site.baseurl}}/docs/gitops-integrations/ci-argument-reference/).
45
46
46
47
{:start="4"}
47
48
1. To generate a YAML snippet with the arguments, on the top-right, click**Generate Manifest**.
@@ -62,7 +63,7 @@ max-width="50%"
62
63
1. Paste the copied manifest as the last step in your CI pipeline.
63
64
64
65
##CI integration argument reference
65
-
The table has been moved to a dedicated standalone topic[here]({{site.baseurl}}/docs/gitops-integrations/ci-integrations/ci-argument-reference/).
66
+
The table has been moved to a dedicated standalone topic[here]({{site.baseurl}}/docs/gitops-integrations/ci-argument-reference/).
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations/codefresh-classic.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,15 @@
1
1
---
2
2
title:"GitOps Codefresh pipeline integration"
3
-
description:""
3
+
description:"Connect CI pipelines with GitOps for enriched image data"
4
4
group:gitops-integrations
5
-
sub_group:ci-integrations
6
5
toc:true
7
6
---
8
7
9
8
10
-
Use Hosted GitOps with any popular Continuous Integration (CI) solution, not just with Codefresh CI. If you have Hosted or Hybrid GitOps, youcan connect yourCIpipelines to Hosted GitOps for deployment with image enrichmentandreporting.
9
+
If Codefresh Pipelines is your CI tool, you can integrate it with GitOps for streamlined deployment, image enrichment, and reporting. This integration allows youto leverage Codefresh Pipelines forCItasks—such as building, testing, and scanning code—while using GitOps for managing deploymentsandtracking enriched image metadata.
11
10
11
+
Connecting a Codefresh Pipeline, adds the CI information to images which are displayed in the Images dashboard, as in the example below.
12
12
13
-
Connecting your CI pipeline, adds the CI information to images which are displayed in the Images dashboard, as in the example below.
14
13
15
14
{% include
16
15
image.html
@@ -82,10 +81,10 @@ The table describes the arguments required to connect Codefresh pipelines to Cod
82
81
83
82
{{site.data.callout.callout_tip}}
84
83
**TIP**
85
-
Except for Git branch and Git repo which are required, you can omit other Git provider arguments. Codefresh retrieves the required values from theruntime context selected for the integration.
84
+
Except for Git branch and Git repo which are required, you can omit other Git provider arguments. Codefresh retrieves the required values from theRuntime context selected for the integration.
86
85
{{site.data.callout.end}}
87
86
88
-
For the complete argument reference, see[CI integration forGitOps argument reference]({{site.baseurl}}/docs/gitops-integrations/ci-integrations/ci-argument-reference/).
87
+
For the complete argument reference, see[GitOpsintegrationsargument reference]({{site.baseurl}}/docs/gitops-integrations/ci-argument-reference/).
89
88
90
89
91
90
{: .table .table-bordered .table-hover}
@@ -126,10 +125,11 @@ For how-to instructions, see [Connect a third-party CI platform/tool to Codefres
126
125
127
126
##Templatization examples for CF arguments
128
127
129
-
Arguments such as`CF_IMAGE`,`CF_GIT_BRANCH`, and`CF_JIRA_MESSAGE` are populated dynamically when the Codefreshintegrationpipeline is triggered. You can templatize the values of these arguments to ensure that the required information is included in the reported image.
128
+
Arguments such as`CF_IMAGE`,`CF_GIT_BRANCH`, and`CF_JIRA_MESSAGE` are populated dynamically when the Codefresh pipeline used for integration is triggered. You can templatize the values of these arguments to ensure that the required information is included in the reported image.
130
129
130
+
{% if page.url contains '/docs/' %}
131
131
Codefresh pipelines have[system variables]({{site.baseurl}}/docs/pipelines/variables/#system-provided-variables) you can use to templatize argument values.
132
-
132
+
{% endif %}
133
133
134
134
###CF_IMAGE examples
135
135
@@ -225,6 +225,7 @@ You can:
225
225
* Filter by status or by date range to view a subset of actions
226
226
* Navigate to the build file for the pipeline, and view the Codefresh report image step
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations/github-actions.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,12 @@
1
1
---
2
2
title:"GitOps GitHub Actions integration"
3
-
description:""
3
+
description:"Connect GitHub Action pipelines with GitOps for enriched image data"
4
4
group:gitops-integrations
5
5
sub_group:ci-integrations
6
6
toc:true
7
7
---
8
8
9
-
Use Hosted GitOps with any popular Continuous Integration (CI) solution, not just with Codefresh CI.
10
-
GitHub Actions is one of the third-party CI solutions that you can connect to Hosted GitOps for deployment with image reporting and enrichment.
9
+
If GitHub Actions is your CI tool, you can integrate it with GitOps for streamlined deployment, image enrichment, and reporting. This integration allows you to leverage GitHub Actions for CI tasks—such as building, testing, and scanning code—while using GitOps for managing deployments and tracking enriched image metadata.
11
10
12
11
Connecting a GitHub Action, adds the CI information to images which are displayed in the Images dashboard, as in the example below.
13
12
@@ -103,6 +102,7 @@ jobs:
103
102
##GitHub Action-GitOps integration settings
104
103
The table describes the arguments required to connect a GitHub Action to Codefresh.
105
104
105
+
For the complete argument reference, see[GitOps integration argument reference]({{site.baseurl}}/docs/gitops-integrations/ci-argument-reference/).
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/ci-integrations/jenkins.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,15 @@
1
1
---
2
2
title:"GitOps Jenkins integration"
3
-
description:""
3
+
description:"Connect Jenkins pipelines with GitOps for enriched image data"
4
4
group:gitops-integrations
5
5
sub_group:ci-integrations
6
6
toc:true
7
7
---
8
8
9
-
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.
10
9
11
-
Connecting a Jenkins pipeline, adds the CI information to images which are displayed in the Images dashboard, as in the example below.
10
+
If Jenkins is your CI tool, you can integrate it with GitOps for streamlined deployment, image enrichment, and reporting. This integration allows you to leverage Jenkins for CI tasks—such as building, testing, and scanning code—while using GitOps for managing deployments and tracking enriched image metadata.
11
+
12
+
Connecting a Jenkins pipeline, adds the CI information to images which are displayed in the Images dashboard, as in the example below.
12
13
13
14
{% include
14
15
image.html
@@ -113,6 +114,8 @@ pipeline {
113
114
##Jenkins-GitOps integration settings
114
115
The table describes the arguments to connect Codefresh pipelines to Codefresh GitOps.
115
116
117
+
For the complete argument reference, see[GitOps integration argument reference]({{site.baseurl}}/docs/gitops-integrations/ci-argument-reference/).
Copy file name to clipboardExpand all lines: _docs/gitops-integrations/container-registries.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,14 @@
1
1
---
2
2
title:"GitOps container registry integrations"
3
-
description:""
3
+
description:"Seamlessly integrate container registries with GitOps for image enrichment"
4
4
group:gitops-integrations
5
5
toc:true
6
6
---
7
7
8
-
Codefreshcan integrate with popular container registries such asDocker Hub, JFrog Artifactory, andmore.
8
+
Codefreshsupports integration with popular container registries, includingDocker Hub, JFrog Artifactory, andothers, enabling seamless management of container images in GitOps workflows.
9
9
10
-
Adding a container registry integration in Codefresh allows you to reference the integration in third-party CI platforms/tools such as GitHub Actions and Codefresh pipelines by the name of the registry integration, instead of explicit credentials. See[Image enrichment with integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/) and[CI integrations]({{site.baseurl}}/docs/gitops-integrations/ci-integrations/).
10
+
By adding a container registry integration in Codefresh, you can reference it by name in third-party CI tools like GitHub Actions or Codefresh Pipelines, rather than using explicit credentials. This simplifies your workflow and enhances security.
11
+
See[Image enrichment with integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/) and[CI integrations]({{site.baseurl}}/docs/gitops-integrations/ci-integrations/).
11
12
12
13
You add a container registry integration in Codefresh by:
13
14
* Defining the integration name
@@ -16,30 +17,31 @@ You add a container registry integration in Codefresh by:
16
17
* Testing the connection
17
18
* Committing the changes
18
19
19
-
You can add more than one integration for the same registry. Once added, Codefresh displays the list of existing integrations with their sync status. You can edit or delete any registry integration.
20
+
You can add multiple integrations for the same registry, providing flexibility for your environment. Codefresh displays a list of existing integrations along with their sync status. You can easily edit or delete any registry integration as needed.
21
+
20
22
21
23
<!--- To see all images from all your container registries integrated with Codefresh in the Codefresh UI, go to [Images](https://g.codefresh.io/2.0/images){:target="\_blank"}. For documentation details, see [Images in Codefresh]({{site.baseurl}}/docs/dashboards/images/)--->
22
24
23
25
24
26
##Configure container registry integrations for GitOps in Codefresh
25
-
Configure the settings for aGitOpscontainer registry integration in Codefresh.
27
+
Configure the settings for a container registry integration with GitOps in Codefresh.
26
28
27
-
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select[**GitOps Integrations**](https://g.codefresh.io/2.0/account-settings/integrations){:target="\_blank"}.
28
-
1. Filter by**Container Registry**, select the container registry, and click**Configure**.
29
+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select**GitOps Integrations**.
30
+
1. Filter by**Container Registry**, select the container registry, andthenclick**Configure**.
29
31
1. If you already have integrations, click**Add**.
30
32
1. Define the arguments for the container registry: