Skip to content

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
merged 6 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@
* [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
* [Dependency track - Python](user-guide/plugins/dependency-track-python.md)
* [Devtron CD Trigger](user-guide/plugins/devtron-cd-trigger.md)
* [DockerSlim](user-guide/plugins/docker-slim.md)
* [GoLang-migrate](user-guide/plugins/golang-migrate.md)
* [Jenkins](user-guide/plugins/jenkins.md)
* [K6 Load Testing](user-guide/plugins/k6-load-testing.md)
Expand All @@ -163,4 +164,4 @@
* [Pull Helm Charts from OCI Registry](user-guide/use-cases/oci-pull.md)
* [Telemetry Overview](user-guide/telemetry.md)
* [Devtron on Graviton](reference/graviton.md)
* [Release Notes](https://github.com/devtron-labs/devtron/releases)
* [Release Notes](https://github.com/devtron-labs/devtron/releases)
63 changes: 63 additions & 0 deletions docs/user-guide/plugins/docker-slim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# DockerSlim

## 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 | Indicates whether the port is exposed in Dockerfile or not | false |
| 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**.



Loading