docs: Document maxperf Docker image variants from #1017 #1024

Open
tcpipuk wants to merge 1 commit from tom/max-perf-docs into main
Owner

Add documentation for the new performance-optimised Docker images with "-maxperf" suffix.

These use the release-max-perf build profile with LTO and target haswell CPU architecture on amd64 for optimal performance.

Also restructure the static prebuilt binary section in generic deployment docs for better clarity and fix various UK English spelling issues.

Preview here:

Add documentation for the new performance-optimised Docker images with "-maxperf" suffix. These use the release-max-perf build profile with LTO and target haswell CPU architecture on amd64 for optimal performance. Also restructure the static prebuilt binary section in generic deployment docs for better clarity and fix various UK English spelling issues. Preview here: - https://tom-max-perf-docs.continuwuity.pages.dev/deploying/generic - https://tom-max-perf-docs.continuwuity.pages.dev/deploying/docker
tcpipuk self-assigned this 2025-09-13 11:31:17 +00:00
docs: Document maxperf Docker image variants from #1017
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Successful in 28s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 49s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 3m30s
1429150cea
Add documentation for the new performance-optimised Docker images with
"-maxperf" suffix. These use the release-max-perf build profile with LTO
and target haswell CPU architecture on amd64 for optimal performance.

Also restructure the static prebuilt binary section in generic deployment
docs for better clarity and fix various UK English spelling issues.
@ -33,1 +23,3 @@
for performance.
#### Performance-optimised builds
For x86_64 systems with CPUs from the last ~15 years, use the `-haswell-` optimised binaries for best performance. These binaries enable hardware-accelerated CRC32 checksumming in RocksDB, which significantly improves database performance. The haswell instruction set provides an excellent balance of compatibility and speed.
Owner

I don't know about removing the hard-wrapping in this file?

I don't know about removing the hard-wrapping in this file?
@ -34,1 +25,4 @@
For x86_64 systems with CPUs from the last ~15 years, use the `-haswell-` optimised binaries for best performance. These binaries enable hardware-accelerated CRC32 checksumming in RocksDB, which significantly improves database performance. The haswell instruction set provides an excellent balance of compatibility and speed.
If you're using Docker instead, equivalent performance-optimised images are available with the `-maxperf` suffix (e.g. `forgejo.ellis.link/continuwuation/continuwuity:latest-maxperf`). These images use the `release-max-perf` build profile with [link-time optimisation (LTO)](https://doc.rust-lang.org/cargo/reference/profiles.html#lto) and, for amd64, target the haswell CPU architecture.
Owner

FYI I think we're already doing cross-language LTO in the docker images, not sure what maxperf is actually changing with fat LTO? Or the other option in the build profiles (side note release-high-perf sets panic = abort which really shouldn't be run in prod)

FYI I think [we're already doing cross-language LTO](https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docker/Dockerfile#L109-L115) in the docker images, not sure what maxperf is actually changing with fat LTO? Or the other option in the build profiles (side note release-high-perf sets panic = abort which really shouldn't be run in prod)
nex added this to the 0.5.0 milestone 2025-09-25 02:14:20 +00:00
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Successful in 28s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 49s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 3m30s
Required
Details
This pull request is blocked because it's outdated.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin tom/max-perf-docs:tom/max-perf-docs
git switch tom/max-perf-docs
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1024
No description provided.