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

Commit7e5243b

Browse files
authored
Classic cr 20145 jira integration (#901)
* Update jira.mdInitial draft of updated content* Update jira.md* Update jira.md* Update jira.md* Update content* Update jira contentAdded section on GitOps Jira integration for CI pipelines* Update jira.md* Update jira.md* UpdatesRestored all GitOps deployment content* Create 2024-feb-release-notes.md* Delete 2024-feb-release-notes.md* Update jira.md
1 parentc234a48 commit7e5243b

File tree

4 files changed

+257
-132
lines changed

4 files changed

+257
-132
lines changed

‎_docs/ci-cd-guides/gitops-deployments.md‎

Lines changed: 90 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For an overview on GitOps, Argo CD, and how Codefresh implements both, see [Code
1414
Even though GitOps is not specific to Kubernetes, current GitOps tools work great with Kubernetes in the form of cluster controllers. The GitOps controller monitors the state of the Git repository, and when there is a commit, instructs the cluster to match the same state.
1515

1616

17-
Codefresh has native support for GitOps, from creatingGitOpsapplications, deploying them, andmonitoring and managing the deployments with dedicated dashboardsoptimized for GitOps.
17+
Codefresh has native support for GitOps, from creatingArgo CDapplications, deploying,monitoring, and managingthem viatheGitOps paradigm, anddeployments with dedicated dashboardscompai GitOps.
1818

1919
{% include
2020
image.html
@@ -31,8 +31,8 @@ Starting with pointers on setting up Git repos, this guide takes you through the
3131
* Connecting Argo CD and Codefresh
3232
* Creating a CI pipeline for GitOps
3333
* Creating an Argo CD application for GitOps
34-
* Deploying the application
35-
* Working with the GitOps Apps dashboard, anda look at the insights from theGitOps Dashboard (Home) and DORA dashboards
34+
* Deploying theArgo CDapplication
35+
* Working with the GitOps Apps dashboard, and GitOps Dashboard (Home) and DORA dashboards for additional insights
3636

3737

3838

@@ -48,7 +48,8 @@ As a live example you can use:
4848
The repository with the application code contains the source code plus a Dockerfile. You can use any Git workflow for this repository. We will create a pipeline in Codefresh that creates a container image on each commit.
4949

5050
* For the Kubernetes configuration, the[https://github.com/codefresh-contrib/gitops-kubernetes-configuration](https://github.com/codefresh-contrib/gitops-kubernetes-configuration){:target="\_blank"} repository.
51-
The configuration repository holds the kubernetes manifests. This is one of the critical points of GitOps:
51+
The configuration repository holds the Kubernetes manifests.
52+
This is one of the critical points of GitOps:
5253
* The configuration repository holds the manifests that are also present in the Kubernetes cluster
5354
* Whenever there is a commit to the configuration repository, the cluster is notified to deploy the new version of the files (we will set up a pipeline for this)
5455
* Every subsequent configuration change should become a Git commit. Ad-hoc changes to the cluster with`kubectl` commands are**NOT** allowed
@@ -58,7 +59,7 @@ As a live example you can use:
5859

5960
**Fork repositories**
6061

61-
* Before continuing, if don't have already your own example application, fork all three repositories into your own GitHub account.
62+
* Before continuing, ifyoudon't have your own example application, fork all three repositories into your own GitHub account.
6263

6364
##Connecting ArgoCD and Codefresh
6465

@@ -69,91 +70,29 @@ See:
6970
[Hosted GitOps runtime]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/)
7071
[Hybrid GitOps runtime]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/)
7172

72-
If you don't have aruntime installed already, for this guide, install the Hosted GitOps runtime.
73+
If you don't have aGitOps Runtime installed already, for this guide, install the Hosted GitOps runtime.
7374

7475
<!--- Add hosted runtime image-->
7576

76-
##Creating a CI Pipeline for GitOps
77+
##Creating a CI Pipeline forimage enrichment withGitOps Jira integration
7778

7879
Creating a CI pipeline for GitOps is no different from creating a standard pipeline. The only difference is that as the final action for the pipeline, you should add the report image action provided by Codefresh. The report image action correlates the Docker image with the Git repository details, Jira issues associated with it, and additional information from the registry that stores the image.
7980

8081
Follow these steps to create a CI pipeline for GitOps:
8182

82-
1. Set up Jira and registry integrations for GitOps
83-
You need to connect Jira and your container registry to Codefresh. These integrations are specific to GitOps, and differ from the pipeline integrations that you may have already set up.
84-
Once you set up the GitOps integrations, you can reference them in the CI pipeline's report image step for Codefresh to retrieve the necessary information.
85-
1. Set up Codefresh pipeline integration for GitOps
86-
1. Create your Codefresh pipeline as you usually do, using the Example CI pipeline for GitOps as a guide:
83+
1. Set up[issue-tracking and container registry integrations for GitOps](#set-up-jira-and-docker-hub-integrations-for-gitops-image-enrichment)
84+
You need to connect Jira and your container registry to Codefresh.
85+
>**NOTE**
86+
These integrations are specific to GitOps, and differ from the Jira and container registry integrations that you may have already set up for pipelines.
87+
Once you set up the GitOps integrations for Jira and container registries, you can reference them in the CI pipeline's report image step for Codefresh to retrieve the necessary information.
88+
1. Set up[Codefresh pipeline integration for GitOps](#set-up-codefresh-pipeline-integration-for-gitops)
89+
1. Create your Codefresh pipeline as you usually do, using the[Example CI pipeline for GitOps] as a guide:
8790
Use existing CI actions for compiling code, running unit tests, security scanning etc.
8891
1. Place the final action in the pipeline as the “report image” action provided by Codefresh.
89-
See Codefresh report image
9092
1. When the pipeline completes execution, Codefresh retrieves the information on the image that was built and its metadata through the integration names specified.
91-
1. View the enriched image in Codefresh’s Images dashboard, and in any application in which it is used.
92-
93-
###Example CI pipeline for GitOps
94-
95-
Below is an example of a CI pipeline for GitOps.
96-
97-
The pipeline:
98-
*[Packages your Docker images]({{site.baseurl}}/docs/ci-cd-guides/building-docker-images/)
99-
* Runs[tests]({{site.baseurl}}/docs/testing/unit-tests/)
100-
* Performs[security scans]({{site.baseurl}}/docs/testing/security-scanning/)
101-
* Reports image information to Codefresh
102-
103-
`codefresh.yml`
104-
{% highlight yaml %}
105-
{% raw %}
106-
107-
version: "1.0"
108-
stages:
109-
- "clone"
110-
- "build"
111-
- "report"
112-
113-
steps:
114-
clone:
115-
title: "Cloning repository"
116-
type: "git-clone"
117-
repo: "${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}"
118-
revision: "${{CF_BRANCH}}"
119-
stage: "clone"
120-
121-
build:
122-
title: "Building Docker image"
123-
type: "build"
124-
image_name: "${{CF_REPO_OWNER}}/color"
125-
working_directory: "${{clone}}"
126-
tag: "${{CF_SHORT_REVISION}}"
127-
dockerfile: "Dockerfile"
128-
registry: docker-lr
129-
stage: "build"
130-
131-
ReportImageMetadataAll:
132-
title: Report image to Codefresh CD
133-
type: codefresh-report-image:1.0.10
134-
working_directory: /code
135-
stage: "report"
136-
arguments:
137-
CF_API_KEY: '${{CF_API_KEY}}'
138-
CF_IMAGE: 'docker.io/${{CF_REPO_OWNER}}/color:${{CF_SHORT_REVISION}}'
139-
CF_CONTAINER_REGISTRY_INTEGRATION: docker
140-
CF_RUNTIME_NAME: "codefresh-hosted"
141-
CF_GITHUB_TOKEN: '${{GITHUB_TOKEN}}'
142-
CF_GIT_PROVIDER: github
143-
CF_GIT_REPO: '${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}'
144-
CF_GIT_BRANCH: '${{CF_BRANCH}}'
145-
CF_ISSUE_TRACKING_INTEGRATION: jira
146-
CF_JIRA_MESSAGE: "${{CF_COMMIT_MESSAGE}}"
147-
CF_JIRA_PROJECT_PREFIX: CR
148-
149-
{% endraw %}
150-
{% endhighlight yaml %}
93+
1. View the enriched image in Codefresh’s[Images dashboard]({{site.baseurl}}/docs/dashboards/images/), and in any application in which it is used.
15194

15295

153-
Pipeline steps:
154-
1.[Git-clone step]({{site.baseurl}}/docs/pipelines/steps/git-clone/): Checks out the source code of an application
155-
1.[Build step]({{site.baseurl}}/docs/pipelines/steps/build/): Builds a Docker image
156-
1.`codefresh-report-image`: Reports the Jira and registry information to Codefresh. Populates the values of the Codefresh Git variables from those you defined in the respective GitOps integrations.
15796

15897

15998
You can see the associated metadata in the[Images dashboard](https://g.codefresh.io/images/){:target="\_blank"}.
@@ -219,14 +158,77 @@ Read more in [GitOps CI integrations]({{site.baseurl}}/docs/gitops-integrations/
219158

220159
<!--- View the enriched image in the Images-->
221160

161+
###Example CI pipeline for GitOps
162+
163+
Below is an example of a CI pipeline for GitOps.
164+
165+
The pipeline:
166+
*[Packages your Docker images]({{site.baseurl}}/docs/ci-cd-guides/building-docker-images/)
167+
* Runs[tests]({{site.baseurl}}/docs/testing/unit-tests/)
168+
* Performs[security scans]({{site.baseurl}}/docs/testing/security-scanning/)
169+
* Reports image information to Codefresh
170+
171+
`codefresh.yml`
172+
{% highlight yaml %}
173+
{% raw %}
174+
175+
version: "1.0"
176+
stages:
177+
- "clone"
178+
- "build"
179+
- "report"
222180

181+
steps:
182+
clone:
183+
title: "Cloning repository"
184+
type: "git-clone"
185+
repo: "${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}"
186+
revision: "${{CF_BRANCH}}"
187+
stage: "clone"
188+
189+
build:
190+
title: "Building Docker image"
191+
type: "build"
192+
image_name: "${{CF_REPO_OWNER}}/color"
193+
working_directory: "${{clone}}"
194+
tag: "${{CF_SHORT_REVISION}}"
195+
dockerfile: "Dockerfile"
196+
registry: docker-lr
197+
stage: "build"
198+
199+
ReportImageMetadataAll:
200+
title: Report image to Codefresh CD
201+
type: codefresh-report-image:1.0.10
202+
working_directory: /code
203+
stage: "report"
204+
arguments:
205+
CF_API_KEY: '${{CF_API_KEY}}'
206+
CF_IMAGE: 'docker.io/${{CF_REPO_OWNER}}/color:${{CF_SHORT_REVISION}}'
207+
CF_CONTAINER_REGISTRY_INTEGRATION: docker
208+
CF_RUNTIME_NAME: "codefresh-hosted"
209+
CF_GITHUB_TOKEN: '${{GITHUB_TOKEN}}'
210+
CF_GIT_PROVIDER: github
211+
CF_GIT_REPO: '${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}'
212+
CF_GIT_BRANCH: '${{CF_BRANCH}}'
213+
CF_ISSUE_TRACKING_INTEGRATION: jira
214+
CF_JIRA_MESSAGE: "${{CF_COMMIT_MESSAGE}}"
215+
CF_JIRA_PROJECT_PREFIX: CR
216+
217+
{% endraw %}
218+
{% endhighlight yaml %}
219+
220+
221+
Pipeline steps:
222+
1.[Git-clone step]({{site.baseurl}}/docs/pipelines/steps/git-clone/): Checks out the source code of an application
223+
1.[Build step]({{site.baseurl}}/docs/pipelines/steps/build/): Builds a Docker image
224+
1.`codefresh-report-image`: Reports the Jira and registry information to Codefresh. Populates the values of the Codefresh Git variables from those you defined in the respective GitOps integrations.
223225

224226
##Creating an Argo CD application for GitOps
225227

226228
Codefresh provides an easy-to-use editor to create GitOps-compatible Argo CD applications.
227-
When creating the application, you can use the Form mode or the YAML editor, and toggle between the two.
229+
When creating the application, you can use the Form mode or the YAML editor, andalwaystoggle between the two.
228230

229-
A GitOpsapplication includes:
231+
An Argo CDapplication in Codefresh includes:
230232

231233
* Application definitions
232234
Application definitions include the name, runtime, and the location of the YAML manifest. You can define subfolders by adding / to the path.
@@ -452,12 +454,12 @@ The Configuration tab displays the definitions for the application. Apart from t
452454

453455
For more information on application definitions, see [Creating GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application).
454456

455-
##GitOps Dashboardand DORA dashboards
457+
##Homeand DORA Metrics dashboards
456458

457-
If you have several applications and deployments, theGitOps Dashboardand the DORAmetrics dashboards are the go-to dashboards for managers and developers alike.
459+
If you have several applications and deployments, theHome Dashboard and the DORAMetrics dashboards are the go-to dashboards for managers and developers alike.
458460

459-
The **GitOps Dashboard**, part ofthe Home dashboard, offers a global view ofruntimes, managed clusters, deployments, and applications. For system-wide visualization in real-time, this is your dashboard of choice in Codefresh.
460-
* Go to [GitOps Dashboard](https://g.codefresh.io/2.0/?startDateFrom=2023-04-26&startDateTo=2023-05-03&time=LAST_7_DAYS){:target="\_blank"}.
461+
The **GitOps Dashboard** inthe Home dashboard offers a global view ofGitOps Runtimes, managed clusters, deployments, and applications. For system-wide visualization in real-time, this is your dashboard of choice in Codefresh.
462+
* Go to [Home Dashboard](https://g.codefresh.io/2.0/?startDateFrom=2023-04-26&startDateTo=2023-05-03&time=LAST_7_DAYS){:target="\_blank"}.
461463

462464
For detailed information, see [GitOps Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/#gitops-dashboard).
463465

@@ -491,7 +493,7 @@ max-width="80%"
491493
The GitOps Apps dashboard displays applications created using the [app-of-apps pattern](https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/){:target="\_blank"}. If you have a number of applications that are related, and you always
492494
install them as a set in your cluster, you can group them in a single Application. The parent application can be defined using [declarative Argo Resources](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/){:target="\_blank"}.
493495

494-
As an example, you might find that you always install in your cluster Linkerd, Prometheus and Ambassador. You can group all of themin a singleApplication and deploy them all at once.
496+
As an example, you might find that you always install in your cluster Linkerd, Prometheus, and Ambassador. You can group all of themas a singleapplication and deploy them all at once.
495497

496498
You can find an existing example of app-of-apps at [https://github.com/argoproj/argocd-example-apps/tree/master/apps](https://github.com/argoproj/argocd-example-apps/tree/master/apps){:target="\_blank"}. It uses [Helm]({{site.baseurl}}/docs/example-catalog/cd-examples/helm/), but you can use any other Kubernetes templating mechanism such as [Kustomize]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-with-kustomize/), or even plain manifests.
497499

@@ -525,5 +527,7 @@ Clicking on the parent application takes you to the Current State tab with the c
525527
{{site.data.callout.end}}
526528

527529

528-
<!---## Related articles
529-
[Progressive delivery with Argo Rollouts]({{site.baseurl}}/docs/ci-cd-guides/progressive-delivery/) -->
530+
## Related articles
531+
[Image enrichment with integrations for GitOps]({{site.baseurl}}/docs/ci-cd-guides/image-enrichment/)
532+
[GitOps issue tracking integrations]({{site.baseurl}}/docs/gitops-integrations/issue-tracking/)
533+
[GitOps container registry integrations]({{site.baseurl}}/docs/gitops-integrations/container-registries/)

‎_docs/gitops-integrations/image-enrichment-overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title:"GitOps imageenrichment with integrations"
2+
title:"Imageenrichment with integrations for GitOps"
33
description:""
44
group:gitops-integrations
55
redirect_from:

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp