Warn users about file carving size limits#47376
Conversation
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Hey @sgress454 can you please review this PR? |
mike-j-thomas
left a comment
There was a problem hiding this comment.
@noahtalerman, some fixes and grammar suggestions. Plus a bunch of line breaks that need fixing 👍
| ``` | ||
|
|
||
| For the (default) MySQL Backend, the configured `carver_block_size` must be less than the value of | ||
| `max_allowed_packet` in the MySQL connection, allowing for some overhead. The default for [MySQL 8](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_allowed_packet) it is 64MB (`67108864`). |
There was a problem hiding this comment.
@noahtalerman, is this supposed to be on a separate line? Looks like a copy/paste bug.
There was a problem hiding this comment.
Thanks for catching this!
| `max_allowed_packet` in the MySQL connection, allowing for some overhead. The default for [MySQL 8](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_allowed_packet) it is 64MB (`67108864`). | ||
|
|
||
| For the S3-compatible backend, `carver_block_size` must be set to at least 5MiB (`5242880`) due to the | ||
| [constraints of S3's multipart |
| - `FLEET_S3_FORCE_S3_PATH_STYLE=true` | ||
| - `FLEET_S3_REGION=localhost` or any non-empty string otherwise Fleet will attempt to derive the region. | ||
|
|
||
| If you're testing file carving locally with the docker-compose environment, the `--dev` flag on Fleet server will automatically point carves to the local RustFS container and write to the `carves-dev` bucket (created automatically) without needing to set additional configuration. |
There was a problem hiding this comment.
| If you're testing file carving locally with the docker-compose environment, the `--dev` flag on Fleet server will automatically point carves to the local RustFS container and write to the `carves-dev` bucket (created automatically) without needing to set additional configuration. | |
| If you're testing file carving locally with the Docker-Compose environment, the `--dev` flag on the Fleet server will automatically point carves to the local RustFS container and write to the `carves-dev` bucket (created automatically) without needing to set additional configuration. |
There was a problem hiding this comment.
@noahtalerman, should "docker-compose" be a proper noun?
There was a problem hiding this comment.
Just took out mention of Docker entirely.
| ### Ensure `carver_block_size` is set appropriately | ||
|
|
||
| `carver_block_size` is an option that sets the size of each part of a file carve that Fleet's agent (fleetd) | ||
| sends to the Fleet server. |
There was a problem hiding this comment.
@noahtalerman, looks like another copy/paste line break.
| sends to the Fleet server. | ||
|
|
||
| When using the MySQL backend (default), this value must be less than the `max_allowed_packet` | ||
| setting in MySQL. If it is too large, MySQL will reject the writes. |
There was a problem hiding this comment.
Same here, and all lines up to 115.
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
efa3f1f
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
|
Thanks @mike-j-thomas! I think all these line break issues are because folks are using "Prettier" in their text editor which has rules to limit line length. That makes sense for Typescript / go code but not for markdown. I opened a separate PR to update Prettier's rules: |
|
@rachaelshaw and @sharon-fdm one more review! Apologies. After review, please merge in the PR if you're able to. |

Uh oh!
There was an error while loading. Please reload this page.