Skip to content

Commit f84db50

Browse files
ashokdevtronkomalreddy3
authored andcommitted
doc: Added Linked CI with Child Info + Runtime Build Parameters (#4991)
* Added LinkedCI with Child Information * Added Build Parameters Guide in App & App Group * PM Feedback Incorporated * PM Feedback - Revision * Added Enterprise Tag in Hintblock - AG Build Param * Removed unappealing full-stop
1 parent d867c59 commit f84db50

File tree

3 files changed

+100
-40
lines changed

3 files changed

+100
-40
lines changed

docs/user-guide/application-groups.md

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,33 @@ The **Build & Deploy** tab of your application group enables you to trigger the
5353

5454
![Figure 5: Selecting Commit](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-commit-1.jpg)
5555

56-
Repeat the step for other applications, and then click **Start Build**.
56+
3. Similar to application, you can also [pass build parameters](./deploying-application/triggering-ci.md#passing-build-parameters) in application groups before triggering the build.
5757

58-
![Figure 6: Building Images](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-commit-2.jpg)
58+
{% hint style="info" %}
59+
Passing build parameters feature is only available in <img src="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg">
60+
{% endhint %}
61+
62+
* Go to the **Parameters** tab.
63+
64+
![Figure 6: Parameters Tab](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/ag-parameter-tab.jpg)
65+
66+
* Click **+ Add parameter**.
67+
68+
![Figure 7: Adding a Parameter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/ag-add-parameter.jpg)
69+
70+
* Enter your key-value pair as shown below.
71+
72+
![Figure 8: Entering Key-Value Pair](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/ag-key-value.jpg)
73+
74+
* You may follow the above steps for other applications too, and then click **Start Build**.
75+
76+
![Figure 9: Choosing Commit for Other Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/ag-next-app.jpg)
77+
78+
![Figure 10: Passing Build Parameters and Triggering Build](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/ag-start-build.jpg)
5979

60-
3. The builds will be initiated, following which, you can close the `Build image` screen.
80+
4. The builds will initiate, following which, you can close the `Build image` screen.
6181

62-
![Figure 7: Triggered Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/build-image.jpg)
82+
![Figure 11: Triggered Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/build-image.jpg)
6383

6484
{% hint style="info" %}
6585
Users need to have [Build and deploy permission](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to trigger the build
@@ -76,7 +96,7 @@ The **Configurations** tab of your application group allows you to configure the
7696

7797
As shown below, you can handle the configurations of more than one application from a single screen.
7898

79-
![Figure 8: Configurations of each App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/configurations.jpg)
99+
![Figure 12: Configurations of each App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/configurations.jpg)
80100

81101
{% hint style="info" %}
82102
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to change their configuration. Please note, you might not be able to change the values of locked keys in deployment template. Refer [Lock Deployment Configuration](./global-configurations/lock-deployment-config.md) to know more.
@@ -89,23 +109,23 @@ The **Build & Deploy** tab of your application group helps you deploy one or mor
89109

90110
1. Select the applications using the checkboxes and click the **Deploy** button present at the bottom.
91111

92-
![Figure 9: Deploy Option](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-app-deploy.jpg)
112+
![Figure 13: Deploy Option](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-app-deploy.jpg)
93113

94114
2. Select the desired container image that you want to deploy for respective application.
95115

96-
![Figure 10: Selecting Image](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-image-1.jpg)
116+
![Figure 14: Selecting Image](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-image-1.jpg)
97117

98118
Repeat the step for other applications too, and then click **Deploy**.
99119

100-
![Figure 11: Deploying Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-image-2.jpg)
120+
![Figure 15: Deploying Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-image-2.jpg)
101121

102122
3. The deployment will be initiated, following which, you can close the screen as shown below.
103123

104-
![Figure 12: Triggered Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/deploy-app.jpg)
124+
![Figure 16: Triggered Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/deploy-app.jpg)
105125

106126
Once the deployment is successful, the pipelines will show `Succeeded`.
107127

108-
![Figure 13: Successful Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/successful.jpg)
128+
![Figure 17: Successful Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/successful.jpg)
109129

110130
{% hint style="info" %}
111131
Users need to have [Build and deploy permission](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to initiate the deployment
@@ -125,31 +145,31 @@ In other words, you can hibernate running applications or unhibernate hibernated
125145

126146
1. In the `Overview` page of your application group, use the checkboxes to choose the applications you wish to hibernate, and click the **Hibernate** button.
127147

128-
![Figure 14a: Selecting Apps to Hibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/hibernate-apps.jpg)
148+
![Figure 18a: Selecting Apps to Hibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/hibernate-apps.jpg)
129149

130150
2. Confirm the hibernation.
131151

132-
![Figure 14b: Confirming Hibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-hibernation.jpg)
152+
![Figure 18b: Confirming Hibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-hibernation.jpg)
133153

134154
3. Hibernation will initiate as shown below. You may close the window.
135155

136-
![Figure 14c: Initiation Status of Hibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/initiated-hibernation.jpg)
156+
![Figure 18c: Initiation Status of Hibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/initiated-hibernation.jpg)
137157

138158
Your applications pods would be scaled down and would stop incurring costs.
139159

140160
#### Unhibernation Process
141161

142162
1. In the same `Overview` page, you can use the checkboxes to choose the hibernated applications you wish to unhibernate, and click the **Unhibernate** button.
143163

144-
![Figure 15a: Selecting Hibernated Apps to Unhibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/unhibernate-apps.jpg)
164+
![Figure 19a: Selecting Hibernated Apps to Unhibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/unhibernate-apps.jpg)
145165

146166
2. Confirm the unhibernation.
147167

148-
![Figure 15b: Confirming Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-unhibernation.jpg)
168+
![Figure 19b: Confirming Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-unhibernation.jpg)
149169

150170
3. Unhibernation will initiate as shown below. You may close the window.
151171

152-
![Figure 15c: Initiation Status of Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/initiated-unhibernation.jpg)
172+
![Figure 19c: Initiation Status of Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/initiated-unhibernation.jpg)
153173

154174
Your applications would be up and running in some time.
155175

@@ -159,27 +179,27 @@ Assume you have multiple applications (maybe 10, 50, 100, or more) showing up in
159179

160180
1. Click the filter next to the application group as shown below.
161181

162-
![Figure 16: Filter Option](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-1.jpg)
182+
![Figure 20: Filter Option](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-1.jpg)
163183

164184
2. The filter will show all the applications present in the group. Click to select the relevant ones.
165185

166-
![Figure 17: All Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-2.jpg)
186+
![Figure 21: All Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-2.jpg)
167187

168188
3. The filter narrows down the list of applications as shown below.
169189

170-
![Figure 18: Filtered Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-3.jpg)
190+
![Figure 22: Filtered Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-3.jpg)
171191

172192
4. (Optional) If required, you can save the filter for future use by clicking **Save selection as filter**.
173193

174-
![Figure 19: Saving a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter.jpg)
194+
![Figure 23: Saving a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter.jpg)
175195

176196
5. Add a name and description to the filter to help you know its purpose, and click **Save**.
177197

178-
![Figure 20: Naming a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-2.jpg)
198+
![Figure 24: Naming a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-2.jpg)
179199

180200
Now when you access the application group, your saved filter will be visible on top.
181201

182-
![Figure 21: Saved Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-3.jpg)
202+
![Figure 25: Saved Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-3.jpg)
183203

184204
{% hint style="info" %}
185205

@@ -218,11 +238,11 @@ Assume you have a few applications whose [build pipelines](../reference/glossary
218238

219239
1. In the **Build & Deploy** tab of your application group, select the intended applications and click the **Change Branch** button present at the bottom.
220240

221-
![Figure 20: Changing Branch](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/change-branch.jpg)
241+
![Figure 26: Changing Branch](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/change-branch.jpg)
222242

223243
2. Enter the new branch name. If your build pipeline has `Branch Regex` as the Source Type, you must ensure your new branch name matches the regex (regular expression) provided in that build pipeline. Once done, click **Update Branch**.
224244

225-
![Figure 21: Updating Branch Name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/update-branch.jpg)
245+
![Figure 27: Updating Branch Name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/update-branch.jpg)
226246

227247
{% hint style="info" %}
228248
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to update their branch

docs/user-guide/creating-application/workflow/ci-pipeline.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -210,18 +210,25 @@ If one code is shared across multiple applications, `Linked Build Pipeline` can
210210
2. On the **App Configuration** page, select **Workflow Editor**.
211211
3. Select **+ New Workflow**.
212212
4. Select **Linked Build Pipeline**.
213-
5. Enter the following fields on the **Create linked build pipeline** screen:
213+
5. On the **Create linked build pipeline** screen:
214+
* Search for the application in which the source CI pipeline is present.
215+
* Select the source CI pipeline from the application that you selected above.
216+
* Enter a new name for the linked CI pipeline.
214217

215-
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ca-workflow-linked.jpg)
218+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/ca-workflow-linked.jpg)
219+
220+
6. Click **Create Linked CI Pipeline**.
216221

217-
* Select the application in which the source CI pipeline is present.
218-
* Select the source CI pipeline from the application that you selected above.
219-
* Enter a name for the linked CI pipeline.
222+
Thereafter, the source CI pipeline will indicate the number of Linked CI pipelines. Upon clicking it, it will display the child information as shown below. It reveals the applications and environments where Linked CI is used for deployment.
220223

221-
Click **Create Linked CI Pipeline**.
224+
![Linked CI with Child Information](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/linkedci.gif)
222225

223226
After creating a linked CI pipeline, you can create a CD pipeline.
224-
Builds cannot be triggered from a linked CI pipeline; they can only be triggered from the source CI pipeline. There will be no images to deploy in the CD pipeline created from the 'linked CI pipeline' at first. To see the images in the CD pipeline of the linked CI pipeline, trigger build in the source CI pipeline. The build images will now be listed in the CD pipeline of the 'linked CI pipeline' whenever you trigger a build in the source CI pipeline.
227+
228+
{% hint style="warning" %}
229+
Linked CI pipelines can't trigger builds. They rely on the source CI pipeline to build images. Trigger a build in the source CI pipeline to see the images available for deployment in the linked CI pipeline's CD stage.
230+
{% endhint %}
231+
225232

226233
### 3. Deploy Image from External Service
227234

docs/user-guide/deploying-application/triggering-ci.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Triggering CI Pipelines
22

3-
To trigger the CI pipeline, first you need to select a Git commit. To select a Git commit, clic the **Select Material** button present on the CI pipeline.
3+
To trigger the CI pipeline, first you need to select a Git commit. To select a Git commit, click the **Select Material** button present on the CI pipeline.
44

55
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/select-material-new.jpg)
66

@@ -10,9 +10,9 @@ Once clicked, a list will appear showing various commits made in the repository,
1010

1111
CI Pipelines with automatic trigger enabled are triggered immediately when a new commit is made to the git branch. If the trigger for a build pipeline is set to manual, it will not be automatically triggered and requires a manual trigger.
1212

13-
{% hint style="info" %}
13+
---
1414

15-
### Partal Cloning Feature [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
15+
## Partal Cloning Feature [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
1616

1717
CI builds can be time-consuming for large repositories, especially for enterprises. However, Devtron's partial cloning feature significantly increases cloning speed, reducing the time it takes to clone your source code and leading to faster build times.
1818

@@ -22,13 +22,49 @@ CI builds can be time-consuming for large repositories, especially for enterpris
2222
* Faster software releases
2323
* Improved productivity
2424

25-
Get in touch with us if you are looking for a way to improve the efficiency of your software development process
26-
{% endhint %}
25+
Get in touch with us if you are looking for a way to improve the efficiency of your software development process.
2726

2827
The **Refresh** icon updates the Git Commits section in the CI Pipeline by fetching the latest commits from the repository. Clicking on the refresh icon ensures that you have the most recent commit available.
2928

3029
The **Ignore Cache** option ignores the previous build cache and creates a fresh build. If selected, will take a longer build time than usual.
3130

31+
---
32+
33+
## Passing Build Parameters [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
34+
35+
{% hint style="warning" %}
36+
### Who Can Perform This Action?
37+
Users need to have [Build & deploy permission](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to pass build parameters.
38+
{% endhint %}
39+
40+
If you wish to pass runtime parameters for a build job, you can provide key-value pairs before triggering the build. Thereafter, you can access those passed values by referencing the corresponding keys in the environment variable dictionary.
41+
42+
**Steps**
43+
44+
1. Go to the **Parameters** tab available on the screen where you select the commit.
45+
46+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/build-parameter-tab.jpg)
47+
48+
2. Click **+ Add parameter**.
49+
50+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/add-parameter.jpg)
51+
52+
3. Enter your key-value pair as shown below.
53+
54+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/key-value.jpg)
55+
56+
<br /> Similarly, you may add more than one key-value pair by using the **+ Add Parameter** button.
57+
58+
4. Click **Start Build**.
59+
60+
{% hint style="info" %}
61+
In case you trigger builds in bulk, you can consider passing build parameters in [Application Groups](../application-groups.md).
62+
{% endhint %}
63+
64+
---
65+
66+
## Fetching Logs and Reports
67+
3268
Click the `CI Pipeline` or navigate to the `Build History` to get the CI pipeline details such as build logs, source code details, artifacts, and vulnerability scan reports.
3369

3470
To access the logs of the CI Pipeline, simply click `Logs`.
@@ -45,7 +81,4 @@ By selecting the `Artifacts` option, you can download reports related to the tas
4581

4682
To check for any vulnerabilities in the build image, click on `Security`. Please note that vulnerabilities will only be visible if you have enabled the `Scan for vulnerabilities` option in the advanced options of the CI pipeline before building the image. For more information about this feature, please refer to this [documentation](../../user-guide/security-features.md).
4783

48-
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/security-scan-report.jpg)
49-
50-
51-
84+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/security-scan-report.jpg)

0 commit comments

Comments
 (0)