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

Commit74fdba6

Browse files
New Jira Integration (#232)
* New Jira Integration* Minor naming change* Changing order of docs* Updated screenshots* Updated link to marketplace app* Update news page* Moving the integration to a separate page* Jira Integration GitOps* Jira Integration GitOps minor change* More details for Jira dashboardsCo-authored-by: Kostis Kapelonis <kostis@codefresh.io>Co-authored-by: Kostis (Codefresh) <39800303+kostis-codefresh@users.noreply.github.com>
1 parent36d99a1 commit74fdba6

File tree

16 files changed

+183
-9
lines changed

16 files changed

+183
-9
lines changed

‎_data/nav.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,9 @@
419419
-title:Helm Integration
420420
url:"/helm"
421421
-title:ArgoCD Integration
422-
url:"/argo-cd"
422+
url:"/argo-cd"
423+
-title:Jira Integration
424+
url:"/jira"
423425
-title:Jenkins Integration
424426
url:"/jenkins-integration"
425427
-title:Google Cloud builder

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,45 @@ This pipeline:
552552

553553
The CD pipeline (described in the previous section) will detect that commit and use the[sync plugin](https://codefresh.io/steps/step/argocd-sync) to instruct ArgoCD to deploy the new tag. Alternatively you can setup the ArgoCD project to auto-sync on its own if it detects changes in the Git repository with the manifests.
554554

555+
##Integrating Codefresh and Jira
556+
557+
>Note that Codefresh currently has to provide you with access to use the Jira Marketplace App. Please get in touch for more information.
558+
559+
Setting up the Codefresh Jira integration provides
560+
* Higher observability of deployments within your GitOps Dashboard
561+
* Higher observability of deployments within your Jira Account
562+
563+
[Our integration section]({{site.baseurl}}/docs/integrations/jira) provides further details on ways to set-up the connection.
564+
565+
Once set-up, you will be able to view information from Jira in the Codefresh GitOps Dashboard. Additionally, Jira will display
566+
567+
* The build status across environments
568+
* The deployment history
569+
* Tickets and how they correlate to deployments
570+
571+
The following screenshots show examples of the provided information. Here is the deployments details for a ticket in JIRA:
572+
573+
{% include image.html
574+
lightbox="true"
575+
file="/images/integrations/jira/jira-integration-one.png"
576+
url="/images/integrations/jira/jira-integration-one.png"
577+
alt="Ticket deployment history"
578+
caption="Ticket deployment history"
579+
max-width="90%"
580+
%}
581+
582+
And here is a complete timeline of your deployments and the feature they contain.
583+
584+
{% include image.html
585+
lightbox="true"
586+
file="/images/integrations/jira/jira-integration-two.png"
587+
url="/images/integrations/jira/jira-integration-two.png"
588+
alt="Jira Deployment timeline"
589+
caption="Jira Deployment timeline"
590+
max-width="90%"
591+
%}
592+
593+
For more information see the[Atlassian Codefresh page](https://www.atlassian.com/solutions/devops/integrations/codefresh) and the[integration documentation]({{site.baseurl}}/docs/integrations/jira/).
555594

556595
##Using a Git repository for the pipelines
557596

‎_docs/integrations/jira.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title:"Jira"
3+
description:""
4+
group:integrations
5+
redirect_from:
6+
-/docs/jira-integration-1/
7+
-/docs/integrations/jira-integration-1/
8+
toc:true
9+
---
10+
Codefresh integrates with Jira in a variety of ways. This site will show how you can integrate with Jira for the highest observability of your GitOps deployments. Alternatively, you can connect to Jira
11+
* Through a[custom step]({{site.baseurl}}/docs/integrations/notifications/jira-integration/#use-jira-within-your-codefresh-pipeline) from our step marketplace so that you can connect your pipelines with Jira
12+
* Through using your own[jira-cli]({{site.baseurl}}/docs/integrations/notifications/jira-integration/#using-your-own-jira-cli)
13+
14+
**Prerequisites needed**:
15+
*[Codefresh Account](https://codefresh.io/docs/docs/getting-started/create-a-codefresh-account/)
16+
*[Jira Account](https://www.atlassian.com/software/jira)
17+
18+
##Setting up the Jira Integration For GitOps
19+
20+
The goal of the Codefresh[GitOps Dashboard]({{site.baseurl}}/docs/ci-cd-guides/gitops-deployments/) is to provide the highest observability into your deployments. The Codefresh GitOps Dashboard tags the Jira issues associated to deployments automatically through the Codefresh Jira Integration. This section will provide an overview of setting up the integration.
21+
22+
On the main Codefresh Dashboard, navigate to`Account Settings`.
23+
24+
{% include image.html
25+
lightbox="true"
26+
file="/images/integrations/jira/codefresh-dashboard.png"
27+
url="/images/integrations/jira/codefresh-dashboard.png"
28+
alt="Codefresh Dashboard"
29+
max-width="90%"
30+
%}
31+
32+
On the`Integration` tap, you will find all of your integrations. Go to`Atlassian Jira` to connect your Jira account with Codefresh.
33+
34+
{% include image.html
35+
lightbox="true"
36+
file="/images/integrations/jira/account-settings.png"
37+
url="/images/integrations/jira/account-settings.png"
38+
alt="Codefresh Integrations"
39+
max-width="90%"
40+
%}
41+
42+
When you Add a new integration, you can choose to authenticate either using the[Codefresh Marketplace App]({{site.baseurl}}/docs/integrations/notifications/jira-integration/#authenticate-with-the-jira-client-key) or with your[Jira Account Details]({{site.baseurl}}/docs/integrations/notifications/jira-integration/#provide-account-details).
43+
44+
###Authenticate with the Codefresh Marketplace App
45+
46+
>Note that Codefresh currently has to provide you with access to use the Jira Marketplace App. Please get in touch for more information.
47+
48+
This is the recommended way to set-up your Jira Integration. To use the Codefresh Marketplace App on Jira, select`Jira Marketplace App` within the Jira Integration Setting in your Codefresh Account.
49+
{% include image.html
50+
lightbox="true"
51+
file="/images/integrations/jira/jira-marketplace-auth.png"
52+
url="/images/integrations/jira/jira-marketplace-auth.png"
53+
alt="Authenticate with the Codefresh Marketplace App"
54+
max-width="90%"
55+
%}
56+
57+
To access the information needed to set-up the integration with the Codefresh Marketplace App, follow these steps:
58+
* Visit the[Codefresh Application](https://marketplace.atlassian.com/apps/1224560/codefresh) on the Atlassian Marketplace.
59+
{% include image.html
60+
lightbox="true"
61+
file="/images/integrations/jira/add-app.png"
62+
url="/images/integrations/jira/add-app.png"
63+
alt="Add Codefresh from Jira App Marketplace"
64+
max-width="90%"
65+
%}
66+
* Install the application through`Get it now`. This will open up a screen to confirm the installation. Confirm the installation.
67+
{% include image.html
68+
lightbox="true"
69+
file="/images/integrations/jira/confirm.png"
70+
url="/images/integrations/jira/confirm.png"
71+
alt="Confirm Installation"
72+
max-width="90%"
73+
%}
74+
* Once the installation has finished, go to the`Apps` menu within your Jira Account.
75+
* Access`Manage your apps`.
76+
{% include image.html
77+
lightbox="true"
78+
file="/images/integrations/jira/manage-apps.png"
79+
url="/images/integrations/jira/manage-apps.png"
80+
alt="Select Manage Apps within Your Jira Account"
81+
max-width="90%"
82+
%}
83+
* You should find a section called`User-installed apps`. Within this section, you should find the Codefresh CI/CD platform integration.
84+
* Click on`Configure`.
85+
{% include image.html
86+
lightbox="true"
87+
file="/images/integrations/jira/configure.png"
88+
url="/images/integrations/jira/configure.png"
89+
alt="Account Information"
90+
max-width="90%"
91+
%}
92+
* This will provide you with your Organization URL and the Client Key. Copy and Paste both into the Jira Integration within your Codefresh Integration Settings.
93+
{% include image.html
94+
lightbox="true"
95+
file="/images/integrations/jira/client-key.png"
96+
url="/images/integrations/jira/client-key.png"
97+
alt="Client Key Information"
98+
max-width="90%"
99+
%}
100+
* Lastly, test your integration to ensure the credentials are set-up correctly.
101+
102+
You are all set!
103+
104+
###Provide Account Details
105+
106+
Using your account details to set-up the integration, you will have to provide
107+
* An`Integration Name`: Any name that you fancy
108+
* The`Jira URL`: This is the URL of your organisation e.g. ‘https://company-name.atlassian.net’
109+
* Your`Jira Username`: This is usually the e-mail that you are logged in with at Jira
110+
* Your Jira`Password`
111+
Alternatively, you could authenticate with the Jira Client Key.
112+
113+
{% include image.html
114+
lightbox="true"
115+
file="/images/integrations/jira/add-jira-password.png"
116+
url="/images/integrations/jira/add-jira-password.png"
117+
alt="Account Information"
118+
max-width="90%"
119+
%}
120+
121+
##Using the Jira Integration
122+
123+
Once Jira is connected to your Codefresh account, you can use both platforms in combination and integrate Jira into your[GitOps workflow]({{site.baseurl}}/docs/ci-cd-guides/gitops-deployments/).
124+
125+
##What to read next
126+
127+
*[GitOps deployments]({{site.baseurl}}/docs/ci-cd-guides/gitops-deployments/)
128+
*[Example for sending notifications to Jira]({{site.baseurl}}/docs/yaml-examples/examples/sending-the-notification-to-jira/)
129+
* Have a look at other things that you can do with your Codefresh Pipeline in the[example section]({{site.baseurl}}/docs/yaml-examples/examples/)
130+
*[Create a pipeline]({{site.baseurl}}/docs/configure-ci-cd-pipeline/pipelines/)

‎_docs/integrations/notifications/jira-integration.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,27 @@ redirect_from:
77
-/docs/integrations/jira-integration-1/
88
toc:true
99
---
10-
The Jira Issue Manager can either be accessed by adding the plugin to your codefresh.yml file or by adding your own jira-cli to your Dockerfile.
10+
Codefresh integrates with Jira in a variety of ways:
11+
* Through the[Jira Integration]({{site.baseurl}}/docs/integrations/jira/) for the highest observability of your GitOps deployments
12+
* Through a[custom step]({{site.baseurl}}/docs/integrations/notifications/jira-integration/#use-jira-within-your-codefresh-pipeline) from our step marketplace so that you can connect your pipelines with Jira
13+
* Alternatively, through using your own[jira-cli]({{site.baseurl}}/docs/integrations/notifications/jira-integration/#using-your-own-jira-cli)
1114

12-
Prerequisites needed:
15+
**Prerequisites needed**:
1316
*[Codefresh Account](https://codefresh.io/docs/docs/getting-started/create-a-codefresh-account/)
14-
*[Have aJira Account](https://www.atlassian.com/software/jira)
17+
*[Jira Account](https://www.atlassian.com/software/jira)
1518

16-
##Plugin Marketplace
19+
##Use Jira Within Your Codefresh Pipeline
1720

18-
Theplugin marketplace offers several freestyle steps that can be used in your Codefresh pipeline throughplugins.
21+
Thestep marketplace offers several freestyle steps that can be used in your Codefresh pipeline throughsteps.
1922

20-
One of thoseplugins is the[Jira Issue Manager](https://codefresh.io/steps/step/jira-issue-manager). It can be used to:
23+
One of thosesteps is the[Jira Issue Manager](https://codefresh.io/steps/step/jira-issue-manager). It can be used to:
2124
* Create a Jira issue
2225
* Comment on existing Jira issues
2326
* Change the status of an issue e.g. once the build is successful
2427
* Add a description to your issue
2528
* And more
2629

27-
More information on how to use the Jira Issue Manager in your Codefresh pipeline are provided[directly in the example]({{site.baseurl}}/docs/yaml-examples/examples/sending-the-notification-to-jira/).
28-
30+
More information is provided[directly in the example]({{site.baseurl}}/docs/yaml-examples/examples/sending-the-notification-to-jira/).
2931

3032
##Using your own jira-cli
3133

‎_docs/whats-new/whats-new.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ toc: true
1515

1616
###April 2021
1717

18+
- Jira integration with Atlassian Open DevOps-[documentation]({{site.baseurl}}/docs/integrations/jira/)
1819
- Canary deployments with Argo Rollouts -[documentation]({{site.baseurl}}/docs/ci-cd-guides/progressive-delivery/#canary-deployment-with-metrics-evaluation)
1920
- Support SLAs -[documentation]({{site.baseurl}}/docs/terms-and-privacy-policy/sla/#support-specific-information)
2021

95.8 KB
Loading
28.6 KB
Loading
32.6 KB
Loading
11 KB
Loading
112 KB
Loading

0 commit comments

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