Skip to content

Commit c16c283

Browse files
ashnamehrotraashnamehrotra
authored
chore: prepare v1.0.0-beta.2 release (#541)
Prepare v1.0.0-beta.2 release
1 parent 60f677b commit c16c283

File tree

27 files changed

+789
-25
lines changed

27 files changed

+789
-25
lines changed

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
VERSION := v1.0.0-beta.1
1+
VERSION := v1.0.0-beta.2
22

33
# Image URL to use all building/pushing image targets
44
TRIVY_SCANNER_IMG ?= ghcr.io/azure/eraser-trivy-scanner:${VERSION}

‎charts/eraser/Chart.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ apiVersion: v2
22
name: eraser
33
description: A Helm chart for Eraser
44
type: application
5-
version: 1.0.0-beta.1
6-
appVersion: v1.0.0-beta.1
5+
version: 1.0.0-beta.2
6+
appVersion: v1.0.0-beta.2
77
home: https://github.com/Azure/eraser
88
sources:
99
- https://github.com/Azure/eraser.git

‎charts/eraser/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documen
3333
| Parameter | Description | Default |
3434
| :-------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ |
3535
| controllerManager.image.repository | Image repository | `ghcr.io/azure/eraser-manager` |
36-
| controllerManager.image.tag | Image tag | Current release version: `v1.0.0-beta.1` |
36+
| controllerManager.image.tag | Image tag | Current release version: `v1.0.0-beta.2` |
3737
| controllerManager.image.pullPolicy | Image pull policy | `Always` |
3838
| controllerManager.securityContext | Security context applied on the container | `{ allowPrivilegeEscalation: false }` |
3939
| controllerManager.resources | The resource request/limits for the container image | limits: 0.1 CPU, 30Mi, requests: 0.1 CPU, 20Mi |
4040
| controllerManager.nodeSelector | The node selector to use for pod scheduling | `kubernetes.io/os: linux` |
4141
| controllerManager.tolerations | The tolerations to use for pod scheduling | `[]` |
4242
| controllerManager.affinity | The node affinity to use for pod scheduling | `{}` |
4343
| eraser.image.repository | Image repository for worker | `ghcr.io/azure/eraser` |
44-
| eraser.image.tag | Image tag for worker | Current release version: `v1.0.0-beta.1` |
44+
| eraser.image.tag | Image tag for worker | Current release version: `v1.0.0-beta.2` |
4545
| nameOverride | Override name if needed | `""` |

‎config/manager/kustomization.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ kind: Kustomization
99
images:
1010
- name: controller
1111
newName: ghcr.io/azure/eraser-manager
12-
newTag: v1.0.0-beta.1
12+
newTag: v1.0.0-beta.2
1313

1414
patches:
1515
- patch: |-
1616
- op: add
1717
path: /spec/template/spec/containers/0/args/-
18-
value: --eraser-image=ghcr.io/azure/eraser:v1.0.0-beta.1
18+
value: --eraser-image=ghcr.io/azure/eraser:v1.0.0-beta.2
1919
- op: add
2020
path: /spec/template/spec/containers/0/args/-
21-
value: --collector-image=ghcr.io/azure/collector:v1.0.0-beta.1
21+
value: --collector-image=ghcr.io/azure/collector:v1.0.0-beta.2
2222
- op: add
2323
path: /spec/template/spec/containers/0/args/-
24-
value: --scanner-image=ghcr.io/azure/eraser-trivy-scanner:v1.0.0-beta.1
24+
value: --scanner-image=ghcr.io/azure/eraser-trivy-scanner:v1.0.0-beta.2
2525
target:
2626
kind: Deployment

‎deploy/eraser.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4417,9 +4417,9 @@ spec:
44174417
containers:
44184418
- args:
44194419
- --leader-elect=false
4420-
- --eraser-image=ghcr.io/azure/eraser:v1.0.0-beta.1
4421-
- --collector-image=ghcr.io/azure/collector:v1.0.0-beta.1
4422-
- --scanner-image=ghcr.io/azure/eraser-trivy-scanner:v1.0.0-beta.1
4420+
- --eraser-image=ghcr.io/azure/eraser:v1.0.0-beta.2
4421+
- --collector-image=ghcr.io/azure/collector:v1.0.0-beta.2
4422+
- --scanner-image=ghcr.io/azure/eraser-trivy-scanner:v1.0.0-beta.2
44234423
command:
44244424
- /manager
44254425
env:
@@ -4430,7 +4430,7 @@ spec:
44304430
fieldPath: metadata.namespace
44314431
- name: OTEL_SERVICE_NAME
44324432
value: eraser-manager
4433-
image: ghcr.io/azure/eraser-manager:v1.0.0-beta.1
4433+
image: ghcr.io/azure/eraser-manager:v1.0.0-beta.2
44344434
livenessProbe:
44354435
httpGet:
44364436
path: /healthz

‎docs/versioned_docs/version-v1.0.0-beta.2/architecture.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Architecture
3+
---
4+
At a high level, Eraser has two main modes of operation: manual and automated.
5+
6+
Manual image removal involves supplying a list of images to remove; Eraser then
7+
deploys pods to clean up the images you supplied.
8+
9+
Automated image removal runs on a timer. By default, the automated process
10+
removes images based on the results of a vulnerability scan. The default
11+
vulnerability scanner is Trivy, but others can be provided in its place. Or,
12+
the scanner can be disabled altogether, in which case Eraser acts as a garbage
13+
collector -- it will remove all non-running images in your cluster.
14+
15+
## Manual image cleanup
16+
17+
Note: metrics are not yet implemented in Eraser v0.4.x, but will be available in the upcoming v1.0.0 release.
18+
19+
<img title="manual cleanup" src="/eraser/docs/img/eraser_manual.png" />
20+
21+
## Automated analysis, scanning, and cleanup
22+
23+
<img title="automated cleanup" src="/eraser/docs/img/eraser_timer.png" />

‎docs/versioned_docs/version-v1.0.0-beta.2/code-of-conduct.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Code of Conduct
3+
---
4+
5+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
6+
7+
Resources:
8+
9+
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
10+
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
11+
- Contact [[email protected]](mailto:[email protected]) with questions or concerns

‎docs/versioned_docs/version-v1.0.0-beta.2/contributing.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Contributing
3+
---
4+
5+
There are several ways to get involved with Eraser
6+
7+
- Join the [mailing list](https://groups.google.com/u/1/g/eraser-dev) to get notifications for releases, security announcements, etc.
8+
- Participate in the [biweekly community meetings](https://docs.google.com/document/d/1Sj5u47K3WUGYNPmQHGFpb52auqZb1FxSlWAQnPADhWI/edit) to disucss development, issues, use cases, etc.
9+
- Join the `#eraser` channel on the [Kubernetes Slack](https://slack.k8s.io/)
10+
- View the [development setup instructions](https://azure.github.io/eraser/docs/development)
11+
12+
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
13+
14+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
15+
16+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

‎docs/versioned_docs/version-v1.0.0-beta.2/custom-scanner.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Custom Scanner
3+
---
4+
5+
## Creating a Custom Scanner
6+
To create a custom scanner for non-compliant images, use the following [template](https://github.com/Azure/eraser-scanner-template/).
7+
8+
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).
9+
10+
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()`.
11+
12+
When complete, provide your custom scanner image to Eraser in deployment.

‎docs/versioned_docs/version-v1.0.0-beta.2/customization.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Customization
3+
---
4+
5+
By default, successful jobs will be deleted after a period of time. You can change this behavior by setting the following flags in the eraser-controller-manager:
6+
7+
- `--job-cleanup-on-success-delay`: Duration to delay job deletion after successful runs. 0 means no delay. Defaults to `0`.
8+
- `--job-cleanup-on-error-delay`: Duration to delay job deletion after errored runs. 0 means no delay. Defaults to `24h`.
9+
- `--job-success-ratio`: Ratio of successful/total runs to consider a job successful. 1.0 means all runs must succeed. Defaults to `1.0`.
10+
11+
For duration, valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

0 commit comments

Comments
 (0)