-
Notifications
You must be signed in to change notification settings - Fork 554
doc: DockerSlim plugin doc #5660
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
ashoknayak777
merged 6 commits into
devtron-labs:main
from
bhushan-nemade-dt:docker-slim
Aug 30, 2024
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
abcb8f8
doc for DockerSlim plugin
bhushan-nemade-dt f0ead12
Updated Docker-Slim to DockerSlim
bhushan-nemade-dt dffa2a3
Minor fixes
bhushan-nemade-dt 3b63308
Merge branch 'main' into docker-slim
ashoknayak777 7777d35
url update
bhushan-nemade-dt 91885c4
Fixes in url
bhushan-nemade-dt 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,63 @@ | ||
| # Docker-Slim | ||
ashoknayak777 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Introduction | ||
| The **DockerSlim** plugin by Devtron helps you to optimize your container deployments by reducing Docker image size. Now with these lighter Docker images, you can perform faster deployments and enhance overall system efficiency. | ||
|
|
||
| {% hint style="warning" %} | ||
| Support for Docker buildx images will be added soon. | ||
| {% endhint %} | ||
|
|
||
| ### Prerequisites | ||
| No prerequisites are required for integrating the **DockerSlim** plugin. | ||
|
|
||
| --- | ||
|
|
||
| ## 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 **DockerSlim** plugin. | ||
| 8. Enter the following [user inputs](#user-inputs) with appropriate values. | ||
| --- | ||
|
|
||
| ## User Inputs | ||
|
|
||
| ### Task Name | ||
| Enter the name of your task | ||
|
|
||
| e.g., `Reduce Docker image size` | ||
|
|
||
| ### 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 DockerSlim plugin is integrated for reducing the size of Docker image.` | ||
|
|
||
| ### Input Variables | ||
|
|
||
| {% hint style="warning" %} | ||
| At `IncludePathFile` input variable list down the file path of essential files from your Dockerfile. Files for which the path is not listed at `IncludePathFile` will may be excluded from the Docker image to reduce size. | ||
| {% endhint %} | ||
|
|
||
| | Variable | Format | Description | Sample Value | | ||
| | ------------------------ | ------------ | ----------- | ------------ | | ||
| | HTTPProbe | BOOL | In Dockerfile the port is expose or not| false | | ||
ashoknayak777 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | IncludePathFile | STRING | File path of required files | /etc/nginx/include.conf | | ||
|
|
||
| ### 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 | ||
| DockerSlim will not be generating an output variable. | ||
|
|
||
| Click **Update Pipeline**. | ||
|
|
||
|
|
||
|
|
||
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.