Skip to content

Commit b684fe7

Browse files
bhushan-nemade-dtbhushan0501ashokdevtron
authored
doc: Pull images from container repository (#5563)
* doc: jenkins-plugin * doc: created doc for pull-images-from-container-registries * Fixed lang issues * Lang fix 2 * Lang fix 3 * Lang fix 4 * Fixed the numbering --------- Co-authored-by: bhushannemade <bhushannemade40@gmail.com> Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>
1 parent ea73f74 commit b684fe7

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@
141141
* [GoLang-migrate](user-guide/plugins/golang-migrate.md)
142142
* [Jenkins](user-guide/plugins/jenkins.md)
143143
* [K6 Load Testing](user-guide/plugins/k6-load-testing.md)
144+
* [Pull images from container repository](user-guide/plugins/pull-images-from-container-repository.md)
144145
* [Semgrep](user-guide/plugins/semgrep.md)
145146
* [SonarQube](user-guide/plugins/sonarqube.md)
146147
* [SonarQube v1.1.0](user-guide/plugins/sonarqube-v1.1.0.md)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Pull images from container repository
2+
3+
## Introduction
4+
The Pull images from container repository plugin helps you poll the specified container repository and fetch the container images to deploy them on your target Kubernetes environments using Devtron's CD pipeline. By integrating this plugin you can:
5+
- Poll the designated container repository to get the specific container image build using external CI like Jenkins and Github actions. Once the image becomes available, you can deploy it to your target Kubernetes environment using Devtron's CD pipeline.
6+
7+
{% hint style="warning" %}
8+
Currently, this plugin only supports ECR registry. Support for other container registries will be added soon.
9+
{% endhint %}
10+
11+
### Prerequisites
12+
Before integrating the **Pull images from the container repository** plugin, ensure that you have a specific container image present at your ECR container repository to pull the image and deploy it to the target environment.
13+
14+
---
15+
16+
## Steps
17+
1. Go to Applications → **Devtron Apps**.
18+
2. Click your application.
19+
3. Go to **App Configuration****Workflow Editor**.
20+
4. Click **New Workflow** and navigate to the **CREATE JOB PIPELINE**.
21+
5. Enter the required fields in the **Basic configuration** window.
22+
6. Under 'TASKS', click the **+ Add task** button.
23+
7. Select the **Pull images from container repository** plugin.
24+
8. Enter the following [user inputs](#user-inputs) with appropriate values.
25+
---
26+
27+
## User Inputs
28+
29+
### Task Name
30+
Enter the name of your task.
31+
32+
e.g., `Pull container image`
33+
34+
### Description
35+
Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task.
36+
37+
e.g., `Pull container image build by external CI`
38+
39+
### Input Variables
40+
41+
| Variable | Format | Description | Sample Value |
42+
| ------------------------ | ------------ | ----------- | ------------ |
43+
| REPOSITORY | STRING | Provide name of repository for polling | dev-repo |
44+
45+
46+
### Trigger/Skip Condition
47+
Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task.
48+
49+
### Output Variables
50+
Pull images from container repository will not be generating an output variable.
51+
52+
Click **Update Pipeline**.
53+
54+

0 commit comments

Comments
 (0)