-
Notifications
You must be signed in to change notification settings - Fork 544
doc: Cosign plugin doc #5665
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
doc: Cosign plugin doc #5665
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5e2e001
doc for cosign plugin
bhushan-nemade-dt 01c846b
edits in task name
bhushan-nemade-dt 18672a7
updates in intro and other fixes.
bhushan-nemade-dt 7e574b1
Attached link to Cosign GitHub repo
bhushan-nemade-dt 8627279
Hyperlink fixes
bhushan-nemade-dt 67c2fb3
Merge branch 'main' into cosign
ashokdevtron File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Cosign | ||
|
||
## Introduction | ||
The **Cosign** plugin by Devtron enables secure signing of your container images, enhancing supply chain security. It authenticates your identity as the creator and ensures image integrity, allowing users to verify the source and detect any tampering. This provides greater assurance to developers incorporating your artifacts into their workflows. | ||
|
||
### Prerequisites | ||
Before integrating the Cosign plugin, ensure that you have configured the Cosign and have a set of private and public keys to sign the container images. | ||
|
||
--- | ||
|
||
## Steps | ||
1. Go to **Applications** → **Devtron Apps**. | ||
2. Click your application. | ||
3. Go to **App Configuration** → **Workflow Editor**. | ||
4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. | ||
5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**. | ||
|
||
{% hint style="warning" %} | ||
If you have already configured workflow, edit the build pipeline, and navigate to **Post-build stage**. | ||
{% endhint %} | ||
|
||
6. Under 'TASKS', click the **+ Add task** button. | ||
7. Click the **Cosign** plugin. | ||
8. Enter the following [user inputs](#user-inputs) with appropriate values. | ||
--- | ||
|
||
## User Inputs | ||
|
||
### Task Name | ||
Enter the name of your task | ||
|
||
e.g., `Signing of container images` | ||
|
||
### Description | ||
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. | ||
|
||
e.g., `The Cosign plugin is integrated for ensuring the authenticity of container images.` | ||
|
||
### Input Variables | ||
|
||
| Variable | Format | Description | Sample Value | | ||
| ------------------------ | ------------ | ----------- | ------------ | | ||
| PrivateKeyFilePath | STRING | Path of private key file in Git repo | cosign/cosign.key | | ||
| PostCommand | STRING | Command to run after image is signed by Cosign | cosign verify $DOCKER_IMAGE | | ||
| ExtraArguments | STRING | Arguments for Cosign command | --certificate-identity=name@example.com | | ||
| CosignPassword | STRING | Password for Cosign private key | S3cur3P@ssw0rd123! | | ||
| VariableAsPrivateKey | STRING | base64 encoded private-key | @{{COSIGN_PRIVATE_KEY}} | | ||
| PreCommand | STRING | Command to get the required conditions to execute Cosign command | curl -sLJO https://raw.githubusercontent.com/devtron-labs/sampleRepo/branchName/private | | ||
|
||
### Trigger/Skip Condition | ||
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. | ||
|
||
### Output Variables | ||
Cosign will not be generating an output variable. | ||
|
||
Click **Update Pipeline**. | ||
|
||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.