Skip to content

Commit f1a50b1

Browse files
doc: CraneCopy plugin doc (#5658)
* doc for * edits in task name * spelling correction * Updated password --------- Co-authored-by: ashokdevtron <[email protected]>
1 parent 99d10f5 commit f1a50b1

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@
137137
* [Copacetic](user-guide/plugins/copacetic.md)
138138
* [Copy Container Image](user-guide/plugins/copy-container-image.md)
139139
* [Cosign](user-guide/plugins/cosign.md)
140+
* [CraneCopy](user-guide/plugins/crane-copy.md)
140141
* [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
141142
* [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
142143
* [Dependency track - Python](user-guide/plugins/dependency-track-python.md)

docs/user-guide/plugins/crane-copy.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# CraneCopy
2+
3+
## Introduction
4+
The **CraneCopy** plugin by Devtron facilitates the transfer of multi-architecture container images between registries. When integrated into Devtron's Post-build stage, this plugin allows you to efficiently copy and store your container images to a specified target repository.
5+
6+
### Prerequisites
7+
No prerequisites are required for integrating the **CraneCopy** plugin.
8+
9+
---
10+
11+
## Steps
12+
1. Go to **Applications****Devtron Apps**.
13+
2. Click your application.
14+
3. Go to **App Configuration****Workflow Editor**.
15+
4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**.
16+
5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**.
17+
18+
{% hint style="warning" %}
19+
If you have already configured workflow, edit the build pipeline, and navigate to **Post-build stage**.
20+
{% endhint %}
21+
22+
6. Under 'TASKS', click the **+ Add task** button.
23+
7. Click the **CraneCopy** plugin.
24+
8. Enter the following [user inputs](#user-inputs) with appropriate values.
25+
26+
---
27+
28+
## User Inputs
29+
30+
### Task Name
31+
Enter the name of your task
32+
33+
e.g., `Copy and store container images`
34+
35+
### Description
36+
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.
37+
38+
e.g., `The CraneCopy plugin is integrated to copy the container images from one registry to another.`
39+
40+
### Input Variables
41+
42+
| Variable | Format | Description | Sample Value |
43+
| ------------------------ | ------------ | ----------- | ------------ |
44+
| RegistryUsername | STRING | Username of target registry for authentication | admin |
45+
| RegistryPassword | STRING | Password for the target registry for authentication | Tr5$mH7p |
46+
| TargetRegistry | STRING | The target registry to push to image | docker.io/dockertest |
47+
48+
49+
### Trigger/Skip Condition
50+
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.
51+
52+
### Output Variables
53+
CraneCopy will not be generating an output variable.
54+
55+
Click **Update Pipeline**.
56+
57+
58+

0 commit comments

Comments
 (0)