-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Prepare v1.4.0-beta.0 release (#949)
Signed-off-by: Sertac Ozercan <[email protected]> Co-authored-by: ashnamehrotra <[email protected]>
- Loading branch information
1 parent
0dd595c
commit ef4af34
Showing
27 changed files
with
1,031 additions
and
31 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| VERSION := v1.3.0-beta.0 | ||
| VERSION := v1.4.0-beta.0 | ||
|
|
||
| MANAGER_TAG ?= ${VERSION} | ||
| TRIVY_SCANNER_TAG ?= ${VERSION} | ||
|
|
||
This file contains 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 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 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 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,21 @@ | ||
| --- | ||
| title: Architecture | ||
| --- | ||
| At a high level, Eraser has two main modes of operation: manual and automated. | ||
|
|
||
| Manual image removal involves supplying a list of images to remove; Eraser then | ||
| deploys pods to clean up the images you supplied. | ||
|
|
||
| Automated image removal runs on a timer. By default, the automated process | ||
| removes images based on the results of a vulnerability scan. The default | ||
| vulnerability scanner is Trivy, but others can be provided in its place. Or, | ||
| the scanner can be disabled altogether, in which case Eraser acts as a garbage | ||
| collector -- it will remove all non-running images in your cluster. | ||
|
|
||
| ## Manual image cleanup | ||
|
|
||
| <img title="manual cleanup" src="/eraser/docs/img/eraser_manual.png" /> | ||
|
|
||
| ## Automated analysis, scanning, and cleanup | ||
|
|
||
| <img title="automated cleanup" src="/eraser/docs/img/eraser_timer.png" /> |
10 changes: 10 additions & 0 deletions
10
docs/versioned_docs/version-v1.4.0-beta.0/code-of-conduct.md
This file contains 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,10 @@ | ||
| --- | ||
| title: Code of Conduct | ||
| --- | ||
|
|
||
| This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | ||
|
|
||
| Resources: | ||
|
|
||
| - [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) | ||
| - [Code of Conduct Reporting](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) |
This file contains 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,14 @@ | ||
| --- | ||
| title: Contributing | ||
| --- | ||
|
|
||
| There are several ways to get involved with Eraser | ||
|
|
||
| - Join the [mailing list](https://groups.google.com/u/1/g/eraser-dev) to get notifications for releases, security announcements, etc. | ||
| - Participate in the [biweekly community meetings](https://docs.google.com/document/d/1Sj5u47K3WUGYNPmQHGFpb52auqZb1FxSlWAQnPADhWI/edit) to disucss development, issues, use cases, etc. | ||
| - Join the `#eraser` channel on the [Kubernetes Slack](https://slack.k8s.io/) | ||
| - View the [development setup instructions](https://eraser-dev.github.io/eraser/docs/development) | ||
|
|
||
| This project welcomes contributions and suggestions. | ||
|
|
||
| This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). |
12 changes: 12 additions & 0 deletions
12
docs/versioned_docs/version-v1.4.0-beta.0/custom-scanner.md
This file contains 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,12 @@ | ||
| --- | ||
| title: Custom Scanner | ||
| --- | ||
|
|
||
| ## Creating a Custom Scanner | ||
| To create a custom scanner for non-compliant images, use the following [template](https://github.com/eraser-dev/eraser-scanner-template/). | ||
|
|
||
| In order to customize your scanner, start by creating a `NewImageProvider()`. The ImageProvider interface can be found can be found [here](../../pkg/scanners/template/scanner_template.go). | ||
|
|
||
| The ImageProvider will allow you to retrieve the list of all non-running and non-excluded images from the collector container through the `ReceiveImages()` function. Process these images with your customized scanner and threshold, and use `SendImages()` to pass the images found non-compliant to the eraser container for removal. Finally, complete the scanning process by calling `Finish()`. | ||
|
|
||
| When complete, provide your custom scanner image to Eraser in deployment. |
Oops, something went wrong.