Skip to content

Commit

Permalink
Merge pull request #10402 from owncloud/fix_antivirus_readme
Browse files Browse the repository at this point in the history
[docs-only] Fix Antivirus readme
  • Loading branch information
mmattel authored Oct 23, 2024
2 parents 0a5552e + a9c00d7 commit 4dfba21
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion services/antivirus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Several factors can make it necessary to limit the maximum filesize the antiviru
> [!CAUTION]
> Streaming of files to the virus scan service still [needs to be implemented](https://github.com/owncloud/ocis/issues/6803). To prevent OOM errors `ANTIVIRUS_MAX_SCAN_SIZE` needs to be set lower than available ram.
### Antivirus Workers

The number of concurrent scans can be increased by setting `ANTIVIRUS_WORKERS`. Be aware that this will also increase memory usage.

### Infected File Handling

The antivirus service allows three different ways of handling infected files. Those can be set via the `ANTIVIRUS_INFECTED_FILE_HANDLING` environment variable:
Expand All @@ -44,4 +48,4 @@ The number of concurrent scans can be increased by setting `ANTIVIRUS_WORKERS`,

### Scaling in Kubernetes

In kubernetes `ANTIVIRUS_WORKERS` and `ANTIVIRUS_MAX_SCAN_SIZE` can be used to trigger the horizontal pod autoscaler by requesting a memory size that is below `ANTIVIRUS_MAX_SCAN_SIZE`. Keep in mind that `ANTIVIRUS_MAX_SCAN_SIZE` amount of memory might be held by `ANTIVIRUS_WORKERS` number of go routines.
In kubernetes, `ANTIVIRUS_WORKERS` and `ANTIVIRUS_MAX_SCAN_SIZE` can be used to trigger the horizontal pod autoscaler by requesting a memory size that is below `ANTIVIRUS_MAX_SCAN_SIZE`. Keep in mind that `ANTIVIRUS_MAX_SCAN_SIZE` amount of memory might be held by `ANTIVIRUS_WORKERS` number of go routines.

0 comments on commit 4dfba21

Please sign in to comment.