diff --git a/docs/versioned_docs/version-v0.4.x/custom-scanner.md b/docs/versioned_docs/version-v0.4.x/custom-scanner.md index 12f3e227d3..db1ec30057 100644 --- a/docs/versioned_docs/version-v0.4.x/custom-scanner.md +++ b/docs/versioned_docs/version-v0.4.x/custom-scanner.md @@ -5,4 +5,4 @@ title: Custom Scanner ## Creating a Custom Scanner To create a custom scanner for non-compliant images, provide your scanner image to Eraser in deployment. -In order for the custom scanner to communicate with the collector and eraser containers, utilize `ReadCollectScanPipe()` to get the list of all non-running images to scan from collector. Then, use `WriteScanErasePipe()` to pass the images found non-compliant by your scanner to eraser for removal. Both functions can be found in [util](../../pkg/utils/utils.go). +In order for the custom scanner to communicate with the collector and eraser containers, utilize `ReadCollectScanPipe()` to get the list of all non-running images to scan from collector. Then, use `WriteScanErasePipe()` to pass the images found non-compliant by your scanner to eraser for removal. Both functions can be found in [util](../../../pkg/utils/utils.go). diff --git a/docs/versioned_docs/version-v0.5.x/custom-scanner.md b/docs/versioned_docs/version-v0.5.x/custom-scanner.md index d7235abbde..b645715bf3 100644 --- a/docs/versioned_docs/version-v0.5.x/custom-scanner.md +++ b/docs/versioned_docs/version-v0.5.x/custom-scanner.md @@ -5,7 +5,7 @@ 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). +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()`. diff --git a/docs/versioned_docs/version-v1.0.x/custom-scanner.md b/docs/versioned_docs/version-v1.0.x/custom-scanner.md index d7235abbde..b645715bf3 100644 --- a/docs/versioned_docs/version-v1.0.x/custom-scanner.md +++ b/docs/versioned_docs/version-v1.0.x/custom-scanner.md @@ -5,7 +5,7 @@ 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). +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()`. diff --git a/docs/versioned_docs/version-v1.1.x/custom-scanner.md b/docs/versioned_docs/version-v1.1.x/custom-scanner.md index d7235abbde..b645715bf3 100644 --- a/docs/versioned_docs/version-v1.1.x/custom-scanner.md +++ b/docs/versioned_docs/version-v1.1.x/custom-scanner.md @@ -5,7 +5,7 @@ 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). +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()`. diff --git a/docs/versioned_docs/version-v1.2.x/custom-scanner.md b/docs/versioned_docs/version-v1.2.x/custom-scanner.md index d7235abbde..b645715bf3 100644 --- a/docs/versioned_docs/version-v1.2.x/custom-scanner.md +++ b/docs/versioned_docs/version-v1.2.x/custom-scanner.md @@ -5,7 +5,7 @@ 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). +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()`. diff --git a/docs/versioned_docs/version-v1.3.x/custom-scanner.md b/docs/versioned_docs/version-v1.3.x/custom-scanner.md index d7235abbde..b645715bf3 100644 --- a/docs/versioned_docs/version-v1.3.x/custom-scanner.md +++ b/docs/versioned_docs/version-v1.3.x/custom-scanner.md @@ -5,7 +5,7 @@ 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). +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()`.