Skip to content

Warn users about file carving size limits#47376

Open
noahtalerman wants to merge 22 commits into
mainfrom
noahtalerman-patch-84
Open

Warn users about file carving size limits#47376
noahtalerman wants to merge 22 commits into
mainfrom
noahtalerman-patch-84

Conversation

@noahtalerman

@noahtalerman noahtalerman commented Jun 10, 2026

Copy link
Copy Markdown
Member
  • Also move contributing doc to a guide. If we're linking to learn more from the API reference I think it should live in an official page on fleetdm.com (another reference page or a guide).

fleet-release
fleet-release previously approved these changes Jun 10, 2026
Comment thread docs/REST API/rest-api.md Outdated
Comment thread docs/REST API/rest-api.md Outdated
Comment thread docs/REST API/rest-api.md Outdated
Comment thread docs/REST API/rest-api.md Outdated
Comment thread articles/file-carving.md
@noahtalerman noahtalerman marked this pull request as ready for review June 16, 2026 13:07
Comment thread articles/file-carving.md Outdated
Co-authored-by: Rachael Shaw <r@rachael.wtf>
fleet-release
fleet-release previously approved these changes Jun 18, 2026
rachaelshaw
rachaelshaw previously approved these changes Jun 18, 2026
@noahtalerman

Copy link
Copy Markdown
Member Author
Screenshot 2026-06-18 at 6 26 10 PM

Hey @sgress454 can you please review this PR?

@noahtalerman noahtalerman requested a review from sharon-fdm June 18, 2026 23:01

@mike-j-thomas mike-j-thomas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahtalerman, some fixes and grammar suggestions. Plus a bunch of line breaks that need fixing 👍

Comment thread articles/file-carving.md Outdated
Comment thread articles/file-carving.md Outdated
```

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`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahtalerman, is this supposed to be on a separate line? Looks like a copy/paste bug.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this!

Comment thread articles/file-carving.md Outdated
`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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahtalerman, same here.

Comment thread articles/file-carving.md Outdated
Comment thread articles/file-carving.md Outdated
Comment thread articles/file-carving.md Outdated
- `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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahtalerman, should "docker-compose" be a proper noun?

@noahtalerman noahtalerman Jun 19, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just took out mention of Docker entirely.

Comment thread articles/file-carving.md Outdated
### 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noahtalerman, looks like another copy/paste line break.

Comment thread articles/file-carving.md Outdated
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, and all lines up to 115.

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
noahtalerman and others added 2 commits June 19, 2026 09:37
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>
@noahtalerman

noahtalerman commented Jun 19, 2026

Copy link
Copy Markdown
Member Author

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:

@noahtalerman

noahtalerman commented Jun 19, 2026

Copy link
Copy Markdown
Member Author

@rachaelshaw and @sharon-fdm one more review! Apologies.

After review, please merge in the PR if you're able to.

sharon-fdm
sharon-fdm previously approved these changes Jun 19, 2026
Comment thread articles/file-carving.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants